Re: Refactoring: Better Variable Names For Better Understanding?

G'day karlgoethebier,

Here's some suggestions for new names along with my rationale for choosing them. If you don't like my suggestions, that's fine; however, perhaps the rationale I've used may help you choosing ones more to your liking.

$test is a boolean which defines whether or not to stop iterating. This could be when you've completed $iterations iterations or earlier if "$re_z * $re_z + $im_z * $im_z > 4" is TRUE. How about renaming $test to $stop_iterating.

$div is a boolean which ~~defines whether or not you're in the (Mandelbrot) set.~~ specifies whether or not the pixel gets a colour. If TRUE, the pixel gets a colour from the palette; if FALSE, the pixel gets black. How about renaming $div to ~~$in_set~~ $colour_pixel.

I think $old_re_z is reasonably meaningful as it stands. I might have used $last_re_z.

Update (Wed 10 Jun 2015 15:49:34 AEST):

Changed the paragraph starting "$div is a boolean ...". This fixes issues noted by karlgoethebier in his response below.

-- Ken

Comment on Re: Refactoring: Better Variable Names For Better Understanding? Select or Download Code

Replies are listed 'Best First'.
Re^2: Refactoring: Better Variable Names For Better Understanding? by karlgoethebier (Abbot) on Jun 05, 2015 at 07:23 UTC
Thank you very much for advice kcott and best regards, Karl ŤThe Crux of the Biscuit is the Apostropheť	[reply]
Re^2: Refactoring: Better Variable Names For Better Understanding? by karlgoethebier (Abbot) on Jun 06, 2015 at 16:30 UTC
With some delay...some more thoughts: "$div is a boolean which defines whether or not you're in the (Mandelbrot) set. If TRUE, the pixel gets a colour from the palette; if FALSE, the pixel gets black. How about renaming $div to $in_set" According to this If TRUE would mean that the pixel is in the set (colored) and If FALSE would mean that the pixel is not in the set (black), right? But i think it should be the other way round because the set is traditionally painted in black: "A point c is colored black if it belongs to the set, and white if not." N.B.: Threads like this are also a challenge to my skills in English. My best regards, Karl ŤThe Crux of the Biscuit is the Apostropheť	[reply]
Re^3: Refactoring: Better Variable Names For Better Understanding? by kcott (Archbishop) on Jun 10, 2015 at 09:18 UTC
"... whether or not ..." In this context, it refers to the two states of the boolean variable: whether (ON) or not (OFF). Perhaps "egal, ob ..."? "But i think it should be the other way round ..." See update to my original response. -- Ken	[reply]
Re^4: Refactoring: Better Variable Names For Better Understanding? by karlgoethebier (Abbot) on Jun 14, 2015 at 18:47 UTC
What i wanted to say: Points in black are the Mandelbrot set But please see Divergence from the Mandelbrot Set: "...In the right-hand image, white points* have iterates with norms less than 2. These are the remaining candidates for membership in the Mandelbrot set"* Holy moly! It seems like it's the other way around again. Thank you very much for your kind replies and for donating so much time for this issue. My best regards, Karl ŤThe Crux of the Biscuit is the Apostropheť	[reply]