fractals 1.2.0

data/README

@@ -0,0 +1,66 @@
+Fractals is a library for creating fractal images in your Ruby programs. It
+currently renders the Burning Ship, Julia Set, Mandelbrot, and Newton fractals
+using the Escape Time or Normalized Iteration Count algorithm. The Themes
+module contains a few predefined coloring palettes, but the Fractal type will
+also accept any user-defined algorithm or theme.
+
+Changes:
+  There have been a few changes since version 1.1.0.  I've removed
+  most of the duplicate code, added Procs where appropriate, and
+  made the syntax more consistent.  The result is much more
+  readable and should be easier to maintain.
+
+  1.  The source code has been split into multiple files.  One for
+      each module.
+  2.  Each of the fractals has been distilled to a single block
+      passed to the Fractal base class' constructor.  This makes
+      it easy to construct new orbits fractals by either
+      inheriting from Fractal or instantiating it directly.
+  3.  Classes have been added for the Burning Ship and Newton
+      fractals.
+  4.  A 'Winter' theme has been added.
+  5.  Users can now choose which dependancy nightmare they'd
+      prefer.  PNG, RMagick and JRuby each have their own renderer.
+      PNGRenderer is the default, but is easy to override with the
+      renderer= method.
+  6.  bailout and max_iterations are no longer constructor
+      parameters.  This is the biggest breaking change.
+  7.  Unit tests have been added for each fractal.
+  8.  Several rake tasks have been added to make installation and
+      gem creation easier.
+
+  See the documentation for a complete API reference.
+
+Installation:
+  sudo gem install fractals-1.2.0.gem
+
+Installing from source:
+  svn checkout http://svn.ryanbaxter.net/fractals/tags/1.2.0 fractals-1.2.0
+  cd fractals-1.2.0
+  rake install
+
+Using Fractals:
+  require 'rubygems'
+  require 'fractals'
+
+  mandelbrot = Fractals::Mandelbrot.new
+  mandelbrot.write
+
+Examples can be found in the examples.rb file.
+
+License:
+  Copyright (c) 2009  Ryan Baxter
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+NAME = 'fractals'
+VERS = '1.2.0'
+RDOC_FILES = ['examples.rb', 'gpl-2.0.txt', 'README']
+
+CLEAN.include ['doc/**/*', 'pkg/**/*']
+
+task :default => [:test_units]
+
+desc 'Cleans directories, creates documentation and gem.'
+task :package => [:clean, :rdoc, :gem]
+
+desc 'Packages and installs the gem.'
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{NAME}-#{VERS}}
+end
+
+desc 'Uninstalls the gem'
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end
+
+desc 'Runs unit tests.'
+Rake::TestTask.new('test_units') do |test|
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+  test.warning = true
+end
+
+desc 'Creates the documentation.'
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc'
+    rdoc.options = ['--title', "Ruby Fractal Library - #{VERS}", '--inline-source']
+    rdoc.main = 'README'
+    rdoc.rdoc_files.add RDOC_FILES
+    rdoc.rdoc_files.add 'lib/**/*.rb'
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERS
+  s.author = 'Ryan Baxter'
+  s.email = 'rcbaxter@gmail.com'
+  s.homepage = 'http://ryanbaxter.net/pages/ruby_fractal_library'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A library for creating fractals in the Ruby programming language.'
+  s.files = %w(examples.rb gpl-2.0.txt Rakefile README) +
+            Dir.glob("{doc,lib,test}/**/*")
+  s.test_files = FileList['test/**/*'].to_a
+  s.require_paths = ['lib']
+  s.has_rdoc = true
+  s.extra_rdoc_files = RDOC_FILES
+end
+
+desc 'Creates the gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end

data/doc/classes/Fractals.html

@@ -0,0 +1,169 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Fractals [Ruby Fractal Library - 1.2.0]</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
+
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Fractals</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+
+
+                <a href="../files/lib/fractals_rb.html">
+
+                lib/fractals.rb
+
+                </a>
+
+
+        <br />
+
+
+                <a href="../files/lib/fractals/algorithms_rb.html">
+
+                lib/fractals/algorithms.rb
+
+                </a>
+
+
+        <br />
+
+
+                <a href="../files/lib/fractals/themes_rb.html">
+
+                lib/fractals/themes.rb
+
+                </a>
+
+
+        <br />
+
+
+                <a href="../files/lib/fractals/renderers_rb.html">
+
+                lib/fractals/renderers.rb
+
+                </a>
+
+
+        <br />
+
+            </td>
+        </tr>
+
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The root module of the <a href="Fractals.html">Fractals</a> namespace.
+</p>
+<h1>Example:</h1>
+<p>
+require &#8216;rubygems&#8217;<br /> require &#8216;fractals&#8217;<br />
+</p>
+<p>
+include <b>Fractals</b><br /><br />
+</p>
+<hr size="1"></hr>
+    </div>
+
+   </div>
+
+
+  </div>
+
+    <!-- if includes -->
+
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+
+        <span class="include-name">Math</span>
+
+      </div>
+    </div>
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Fractals/Algorithms.html" class="link">Fractals::Algorithms</a><br />
+Module <a href="Fractals/Renderers.html" class="link">Fractals::Renderers</a><br />
+Module <a href="Fractals/Themes.html" class="link">Fractals::Themes</a><br />
+Class <a href="Fractals/BurningShip.html" class="link">Fractals::BurningShip</a><br />
+Class <a href="Fractals/Fractal.html" class="link">Fractals::Fractal</a><br />
+Class <a href="Fractals/Julia.html" class="link">Fractals::Julia</a><br />
+Class <a href="Fractals/Mandelbrot.html" class="link">Fractals::Mandelbrot</a><br />
+Class <a href="Fractals/Newton.html" class="link">Fractals::Newton</a><br />
+
+    </div>
+
+
+
+
+    <!-- if method_list -->
+
+
+
+
+  </div>
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Fractals/Algorithms.html

@@ -0,0 +1,125 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Fractals::Algorithms [Ruby Fractal Library - 1.2.0]</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
+
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Fractals::Algorithms</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+
+
+                <a href="../../files/lib/fractals/algorithms_rb.html">
+
+                lib/fractals/algorithms.rb
+
+                </a>
+
+
+        <br />
+
+            </td>
+        </tr>
+
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+A renderer&#8217;s algorithm calculates the color index for complex
+coordinates that lie outside of a fractal&#8217;s set.
+</p>
+<table>
+<tr><td valign="top"><b>EscapeTime</b>:</td><td>The default algorithm for orbits fractals.
+
+</td></tr>
+<tr><td valign="top"><b>NormalizedIterationCount</b>:</td><td>Produces an image with less color banding than the Escape Time algorithm.
+
+</td></tr>
+</table>
+<p>
+<br />
+</p>
+<h1>Example:</h1>
+<p>
+mandelbrot = <a href="Mandelbrot.html#M000016">Mandelbrot.new</a><br />
+mandelbrot.algorithm = <b>Algorithms::NormalizedIterationCount</b>
+</p>
+
+    </div>
+
+   </div>
+
+
+  </div>
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+    <!-- if method_list -->
+
+
+
+
+  </div>
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Fractals/BurningShip.html

@@ -0,0 +1,172 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Fractals::BurningShip [Ruby Fractal Library - 1.2.0]</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
+
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Fractals::BurningShip</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+
+
+                <a href="../../files/lib/fractals_rb.html">
+
+                lib/fractals.rb
+
+                </a>
+
+
+        <br />
+
+            </td>
+        </tr>
+
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+
+                <a href="Fractal.html">
+
+                Fractals::Fractal
+
+               </a>
+
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Michael Michelitsch&#8217;s Burning Ship fractal.
+</p>
+
+    </div>
+
+   </div>
+
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+
+        <a href="#M000014">new</a>&nbsp;&nbsp;
+
+      </div>
+    </div>
+
+  </div>
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+    <!-- if method_list -->
+
+    <div id="methods">
+
+      <h3 class="section-bar">Public Class methods</h3>
+
+
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+
+        <div class="method-heading">
+
+          <a href="#M000014" class="method-signature">
+
+          <span class="method-name">new</span><span class="method-args">(c=Complex(-0.3, -0.5))</span>
+
+          </a>
+
+        </div>
+
+        <div class="method-description">
+
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000014-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/fractals.rb, line 64</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">c</span>=<span class="ruby-constant">Complex</span>(<span class="ruby-value">-0</span><span class="ruby-value">.3</span>, <span class="ruby-value">-0</span><span class="ruby-value">.5</span>))
+      <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">c</span>, {<span class="ruby-identifier">:p</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">2</span>}) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
+                            <span class="ruby-identifier">args</span>[<span class="ruby-identifier">:z</span>] = (<span class="ruby-identifier">args</span>[<span class="ruby-identifier">:z</span>].<span class="ruby-identifier">real</span>.<span class="ruby-identifier">abs</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">sqrt</span>(<span class="ruby-value">-1</span>) <span class="ruby-operator">*</span>
+                              <span class="ruby-identifier">args</span>[<span class="ruby-identifier">:z</span>].<span class="ruby-identifier">image</span>.<span class="ruby-identifier">abs</span>)<span class="ruby-operator">**</span><span class="ruby-identifier">args</span>[<span class="ruby-identifier">:p</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">args</span>[<span class="ruby-identifier">:c</span>]
+                          <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+
+        </div>
+      </div>
+
+
+
+    </div>
+
+
+
+
+  </div>
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>