Programming notes - Revision history

Administrator: /* Notes on C */

2015-04-07T20:21:39Z

Notes on C

← Older revision		Revision as of 15:21, 7 April 2015
Line 17:		Line 17:
	<li>Don't put multiple commands on a single line. One command per line.</li>		<li>Don't put multiple commands on a single line. One command per line.</li>

	<li>I dislike this layout because of its lack of symmetry ~~(even though I realize it's common):~~		<li>I dislike this layout because of its lack of symmetry
	<pre>		<pre>
	if (i==2){		if (i==2) {
	i++;		i++;
	}		}
	</pre>		</pre>
			and think this is cleaner
	Much cleaner is this:
	<pre>		<pre>
	if (i==2)		if (i==2)
Line 30:		Line 30:
	}		}
	</pre>		</pre>
			However, I've now [http://en.wikipedia.org/wiki/Indent_style#Styles learned] that this is a matter of strong debate, and I definitely defer to [http://en.wikipedia.org/wiki/Indent_style#K.26R_style Kernighan & Ritchie] on this (but strongely side with [http://en.wikipedia.org/wiki/Indent_style#Variant:_Stroustrup Stroustrup] on the "else" statement). So, given this situation, choose either of these styles, but be consistent.
	</li>		</li>

Administrator at 14:43, 25 October 2014

2014-10-25T14:43:05Z

← Older revision		Revision as of 09:43, 25 October 2014
Line 1:		Line 1:
	This is a collection of miscellaneous thoughts on coding style recommended for use in our lab.		This is a collection of miscellaneous thoughts on coding style recommended for use in our lab.

			=== Editor ===

			<ol>

			<li>In general, use [http://www.gnu.org/software/emacs/ Emacs]. GNU Emacs for OS X can be downloaded [http://emacsformacosx.com/ here].</li>

			<li>In a pinch, use vi. On our Linux systems as well as on OS X, this is actually [http://en.wikipedia.org/wiki/Vim_%28text_editor%29 vim], which offers syntax highlighting. (Note: on OS X, syntax highlighting seems to be disabled by default. Enable it by adding "syntax on" to your ~/.vimrc file.)</li>

			</ol>

	=== Notes on C ===		=== Notes on C ===

Administrator: /* Notes on C */

2014-07-15T13:57:57Z

Notes on C

← Older revision		Revision as of 08:57, 15 July 2014
Line 7:		Line 7:
	<li>Don't put multiple commands on a single line. One command per line.</li>		<li>Don't put multiple commands on a single line. One command per line.</li>

	<li>~~For~~ symmetry ~~reasons,~~ I ~~dislike~~ ~~this~~ ~~layout~~:		<li>I dislike this layout because of its lack of symmetry (even though I realize it's common):
	<pre>		<pre>
	if (i==2){		if (i==2){
Line 48:		Line 48:
	}		}
	</pre>		</pre>
	~~Due to rounding errors, you~~ should not test for exact equality between two floating point numbers ~~(or~~ a ~~floating~~ ~~point~~ ~~number~~ ~~and~~ a ~~constant).~~ Instead, do:		You should not test for exact equality between two floating point numbers, since this comparison may fail due to rounding errors. Instead, do:
	<pre>		<pre>
	#define EPS 1e-9 /* or some other threshold small enough for your purposes */		#define EPS 1e-9 /* or some other threshold small enough for your purposes */

Administrator at 03:44, 28 June 2014

2014-06-28T03:44:58Z

← Older revision		Revision as of 22:44, 27 June 2014
Line 13:		Line 13:
	}		}
	</pre>		</pre>
	~~Far~~ cleaner is this:		Much cleaner is this:
	<pre>		<pre>
	if (i==2)		if (i==2)
Line 40:		Line 40:

	<li>		<li>
	The following is an ~~amazingly~~ common programming mistake:		The following is a surprisingly common programming mistake:
	<pre>		<pre>
	double x, y;		double x, y;
Line 51:		Line 51:
	<pre>		<pre>
	#define EPS 1e-9 /* or some other threshold small enough for your purposes */		#define EPS 1e-9 /* or some other threshold small enough for your purposes */

	double x, y;		double x, y;
	if (fabs(x-y) < EPS)		if (fabs(x-y) < EPS)

Administrator at 19:54, 25 June 2014

2014-06-25T19:54:31Z

← Older revision		Revision as of 14:54, 25 June 2014
Line 4:		Line 4:

	<ol>		<ol>

			<li>Don't put multiple commands on a single line. One command per line.</li>

	<li>For symmetry reasons, I dislike this layout:		<li>For symmetry reasons, I dislike this layout:

Administrator at 19:51, 25 June 2014

2014-06-25T19:51:19Z

← Older revision		Revision as of 14:51, 25 June 2014
Line 1:		Line 1:
	This is a collection of ~~recommendations~~ on ~~programming~~ style.		This is a collection of miscellaneous thoughts on coding style recommended for use in our lab.

	<ol>

	This is a list of miscellaneous thoughts on coding style recommended for use in our lab.

	=== Notes on C ===		=== Notes on C ===

Administrator: /* Notes on C */

2014-06-25T19:50:49Z

Notes on C

← Older revision		Revision as of 14:50, 25 June 2014
Line 2:		Line 2:

	<ol>		<ol>

			This is a list of miscellaneous thoughts on coding style recommended for use in our lab.

	=== Notes on C ===		=== Notes on C ===

			<ol>

	<li>For symmetry reasons, I dislike this layout:		<li>For symmetry reasons, I dislike this layout:
	<pre>		<pre>
	if (x==2){		if (i==2){
	x++;		i++;
	}		}
	</pre>		</pre>
	Far cleaner is this:		Far cleaner is this:
	<pre>		<pre>
	if (x==2)		if (i==2)
	{		{
	x++;		i++;
	}		}
	</pre>		</pre>
Line 34:		Line 38:
	)		)
	(add-hook 'c-mode-common-hook 'my-c-mode-common-hook)		(add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
			</pre>
			</li>

			<li>
			The following is an amazingly common programming mistake:
			<pre>
			double x, y;
			if (x == y)
			{
			do_something();
			}
			</pre>
			Due to rounding errors, you should not test for exact equality between two floating point numbers (or a floating point number and a constant). Instead, do:
			<pre>
			#define EPS 1e-9 /* or some other threshold small enough for your purposes */
			double x, y;
			if (fabs(x-y) < EPS)
			{
			do_something();
			}
	</pre>		</pre>
	</li>		</li>

Administrator: /* Notes on C */

2014-06-25T19:44:03Z

Notes on C

← Older revision		Revision as of 14:44, 25 June 2014
Line 7:		Line 7:
	<li>For symmetry reasons, I dislike this layout:		<li>For symmetry reasons, I dislike this layout:
	<pre>		<pre>
	if (x==2){		if (x==2){
	x++;		x++;
			}
	}
	</pre>		</pre>
	Far cleaner is this:		Far cleaner is this:
	<pre>		<pre>
	if (x==2)		if (x==2)
			{
	{
	x++;		x++;
			}
	}
	</pre>		</pre>
	</li>		</li>

Administrator: Created page with "This is a collection of recommendations on programming style.

For symmetry reasons, I dislike this layout:
```
     if (x==2){         x++;    ..."
```

2014-06-25T19:41:52Z

Created page with "This is a collection of recommendations on programming style. <ol> === Notes on C === <li>For symmetry reasons, I dislike this layout: <pre> if (x==2){ x++; ..."

New page

This is a collection of recommendations on programming style.

<ol>

=== Notes on C ===

<li>For symmetry reasons, I dislike this layout:
<pre>
if (x==2){
x++;
}
</pre>
Far cleaner is this:
<pre>
if (x==2)
{
x++;
}
</pre>
</li>

<li>For clarity, I prefer indentations to be 8 spaces (not 4). If you follow this, you'll be in [http://www.kernel.org/doc/Documentation/CodingStyle good company]. Insert the following snippet in your ~/.emacs file:
<pre>
(defconst my-c-style
'((c-basic-offset . 8)
(c-offsets-alist . ((substatement-open . 0)
)
)
)
"C Style")
(defun my-c-mode-common-hook ()
(c-add-style "personal" my-c-style t)
(setq fill-column 135)
)
(add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
</pre>
</li>

</ol>

Programming notes - Revision history

Administrator: /* Notes on C */

Administrator at 14:43, 25 October 2014

Administrator: /* Notes on C */

Administrator at 03:44, 28 June 2014

Administrator at 19:54, 25 June 2014

Administrator at 19:51, 25 June 2014

Administrator: /* Notes on C */

Administrator: /* Notes on C */

Administrator: Created page with "This is a collection of recommendations on programming style. === Notes on C === For symmetry reasons, I dislike this layout: if (x==2){ x++; ..."

Administrator: Created page with "This is a collection of recommendations on programming style.
=== Notes on C ===
For symmetry reasons, I dislike this layout:
if (x==2){ x++; ..."