cartesian 0.5.0 → 0.5.2

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.5.1 2011-01-04
+
+* 1 minor enhancements:
+  * code comment/documentation update
+  * README update
+  * website created (textile index)
+
 === 0.5.0 2011-01-03
 
 * 1 major enhancements:
@@ -28,7 +35,7 @@
 === 0.2.3 13-01-2007 20:50
 
 * 1 minor enhancement:
-  * power! (aliased as "**") method added
+  * power! (aliased as '**') method added
 
 === 0.2.1 13-01-2007 01:44
 

data/Manifest.txt

@@ -15,6 +15,7 @@ lib/recursive.rb
 script/console
 script/destroy
 script/generate
+script/txt2html
 test/benchmark.rb
 test/extensions.rb
 test/test_cartesian.rb
@@ -23,3 +24,44 @@ test/test_extensions.rb
 test/test_grid_search.rb
 test/test_helper.rb
 test/test_suite.rb
+website/doc/classes/Array.html
+website/doc/classes/Cartesian.html
+website/doc/classes/Cartesian.src/M000020.html
+website/doc/classes/Cartesian.src/M000021.html
+website/doc/classes/Cartesian.src/M000022.html
+website/doc/classes/Cartesian.src/M000023.html
+website/doc/classes/Cartesian.src/M000026.html
+website/doc/classes/Cartesian.src/M000027.html
+website/doc/classes/CartesianIterator.html
+website/doc/classes/CartesianIterator.src/M000001.html
+website/doc/classes/CartesianIterator.src/M000002.html
+website/doc/classes/CartesianIterator.src/M000003.html
+website/doc/classes/CartesianIterator.src/M000005.html
+website/doc/classes/CartesianIterator.src/M000008.html
+website/doc/classes/CartesianIterator.src/M000009.html
+website/doc/classes/CartesianIterator.src/M000012.html
+website/doc/classes/CartesianIterator.src/M000013.html
+website/doc/classes/Enumerable.html
+website/doc/classes/GridSearch.html
+website/doc/classes/GridSearch.src/M000014.html
+website/doc/classes/GridSearch.src/M000015.html
+website/doc/classes/Iterable.html
+website/doc/classes/Iterable.src/M000016.html
+website/doc/classes/Iterable.src/M000017.html
+website/doc/classes/Iterable.src/M000018.html
+website/doc/classes/Iterable.src/M000019.html
+website/doc/classes/Range.html
+website/doc/created.rid
+website/doc/files/cartesian_iterator_rb.html
+website/doc/files/cartesian_rb.html
+website/doc/files/grid_search_rb.html
+website/doc/fr_class_index.html
+website/doc/fr_file_index.html
+website/doc/fr_method_index.html
+website/doc/index.html
+website/doc/rdoc-style.css
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.rdoc

@@ -1,6 +1,6 @@
 = cartesian
 
-* http://github.com/adrianomitre/cartesian
+* http://adrianomitre.github.com/cartesian/website/index.html
 
 == DESCRIPTION:
 
@@ -25,13 +25,10 @@ One can use the Cartesian module directly
     bar = ["a", "b"]
     Cartesian::product(foo, bar) #=> [[1, "a"], [1, "b"], [2, "a"], [2, "b"]]
 
-or use the methods provided by the mixin in the Array classees
-    require 'cartesian'
-    foo = [1, 2]
-    bar = ["a", "b"]
+or use the methods provided by the mixin in the Array class
     foo.cartesian(bar)  #=> [[1, "a"], [1, "b"], [2, "a"], [2, "b"]]
 
-which include the short and sweet _x_ method
+which include the short'n'sweet _x_ method
     v = [] #=> []
     for a,b in [1,2].x [3,4]
       v << [a,b]

data/lib/cartesian.rb

@@ -1,5 +1,9 @@
-#
-# The CartesianProduct module provide methods for the calculation
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'cartesian_iterator'
+
+# The Cartesian  module provide methods for the calculation
 # of the cartesian producted between two enumerable objects.
 #
 # It can also be easily mixed in into any enumerable class,
@@ -30,15 +34,12 @@
 #   bar = ["a", "b"]
 #   foo.cartesian(bar)  #=> [[1, "a"], [1, "b"], [2, "a"], [2, "b"]]
 #
-
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'cartesian_iterator'
-
 module Cartesian
 
-  VERSION = '0.5.0'
+  # Unfortunately, as of now, the version data must be replicated in ../cartesian.rb,
+  # due to a mix of newgem versions, each requiring a different one. Not DRY :P
+  #
+  VERSION = "0.5.2"
 
   # Produces the cartesian product of self and other.
   # The result is an array of pairs (i.e. two-element arrays).
@@ -164,3 +165,4 @@ end
 class Range
   include Cartesian
 end
+

data/lib/cartesian/version.rb

@@ -1,9 +1,15 @@
 module Cartesian #:nodoc:
+
+  # Unfortunately, as of now, the version data must be replicated in ../cartesian.rb,
+  # due to a mix of newgem versions, each requiring a different one. Not DRY :P
+  #
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 5
-    TINY  = 0
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
+  
 end
+

data/lib/recursive.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 # Code by Brian Schröäer
 # source: http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/151857
 #

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'cartesian' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'cartesian'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Cartesian::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/website/doc/classes/Array.html

@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Array</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <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">Array</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/cartesian_rb.html">
+                cartesian.rb
+                </a>
+        <br />
+                <a href="../files/cartesian_iterator_rb.html">
+                cartesian_iterator.rb
+                </a>
+        <br />
+                <a href="../files/grid_search_rb.html">
+                grid_search.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name"><a href="Cartesian.html">Cartesian</a></span>
+        <span class="include-name"><a href="Iterable.html">Iterable</a></span>
+        <span class="include-name"><a href="GridSearch.html">GridSearch</a></span>
+      </div>
+    </div>
+
+    <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/website/doc/classes/Cartesian.html

@@ -0,0 +1,398 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Cartesian</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <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">Cartesian</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/cartesian_rb.html">
+                cartesian.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The <a href="Cartesian.html">Cartesian</a> module provide methods for the
+calculation of the <a href="Cartesian.html#M000024">cartesian</a> producted
+between two enumerable objects.
+</p>
+<p>
+It can also be easily mixed in into any enumerable class, i.e. any class
+with <a href="Enumerable.html">Enumerable</a> module mixed in. Notice that
+the names of the methods for mixin are different.
+</p>
+<p>
+Module:
+</p>
+<pre>
+  Cartesian::product(foo, bar)
+</pre>
+<p>
+Mixin:
+</p>
+<pre>
+  foo.cartesian( bar )
+</pre>
+<p>
+The module is automatically mixed in <a href="Array.html">Array</a> class.
+</p>
+<h2>Author</h2>
+<p>
+Adriano MITRE &lt;adriano.mitre@gmail.com&gt;
+</p>
+<h2>Example</h2>
+<p>
+as module
+</p>
+<pre>
+  require 'cartesian'
+  foo = [1, 2]
+  bar = [&quot;a&quot;, &quot;b&quot;]
+  Cartesian::product(foo, bar) #=&gt; [[1, &quot;a&quot;], [1, &quot;b&quot;], [2, &quot;a&quot;], [2, &quot;b&quot;]]
+</pre>
+<p>
+as mixin
+</p>
+<pre>
+  require 'cartesian'
+  foo = [1, 2]
+  bar = [&quot;a&quot;, &quot;b&quot;]
+  foo.cartesian(bar)  #=&gt; [[1, &quot;a&quot;], [1, &quot;b&quot;], [2, &quot;a&quot;], [2, &quot;b&quot;]]
+</pre>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000027">**</a>&nbsp;&nbsp;
+      <a href="#M000024">cartesian</a>&nbsp;&nbsp;
+      <a href="#M000022">joined_cartesian</a>&nbsp;&nbsp;
+      <a href="#M000021">joined_product</a>&nbsp;&nbsp;
+      <a href="#M000026">left_product</a>&nbsp;&nbsp;
+      <a href="#M000028">power!</a>&nbsp;&nbsp;
+      <a href="#M000020">product</a>&nbsp;&nbsp;
+      <a href="#M000025">right_product</a>&nbsp;&nbsp;
+      <a href="#M000023">x</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">VERSION</td>
+          <td>=</td>
+          <td class="context-item-value">'0.5.0'</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000021" class="method-detail">
+        <a name="M000021"></a>
+
+        <div class="method-heading">
+          <a href="Cartesian.src/M000021.html" target="Code" class="method-signature"
+            onclick="popupCode('Cartesian.src/M000021.html');return false;">
+          <span class="method-name">joined_product</span><span class="method-args">(first, second)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Behaves as <a href="Cartesian.html#M000020">product</a>, except for the
+elements are joined.
+</p>
+<pre>
+  Cartesian::joined_cartesian( [1,2], %w(A B) ) #=&gt; [&quot;1A&quot;, &quot;1B&quot;, &quot;2A&quot;, &quot;2B&quot;]
+</pre>
+<p>
+or, if mixed in into <a href="Array.html">Array</a>,
+</p>
+<pre>
+  [1,2].joined_cartesian %w(A B) #=&gt; [&quot;1A&quot;, &quot;1B&quot;, &quot;2A&quot;, &quot;2B&quot;]
+</pre>
+        </div>
+      </div>
+
+      <div id="method-M000020" class="method-detail">
+        <a name="M000020"></a>
+
+        <div class="method-heading">
+          <a href="Cartesian.src/M000020.html" target="Code" class="method-signature"
+            onclick="popupCode('Cartesian.src/M000020.html');return false;">
+          <span class="method-name">product</span><span class="method-args">(first, second)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Produces the <a href="Cartesian.html#M000024">cartesian</a> <a
+href="Cartesian.html#M000020">product</a> of self and other. The result is
+an array of pairs (i.e. two-element arrays).
+</p>
+<pre>
+  Cartesian::product( [1,2], %w(A B) ) #=&gt; [[1, &quot;A&quot;], [1, &quot;B&quot;], [2, &quot;A&quot;], [2, &quot;B&quot;]]
+</pre>
+<p>
+or, if mixed in into <a href="Array.html">Array</a>,
+</p>
+<pre>
+  [1,2].cartesian %w(A B) #=&gt; [[1, &quot;A&quot;], [1, &quot;B&quot;], [2, &quot;A&quot;], [2, &quot;B&quot;]]
+</pre>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+
+        <div class="method-heading">
+          <a href="Cartesian.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('Cartesian.src/M000027.html');return false;">
+          <span class="method-name">**</span><span class="method-args">(fixnum)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Concise way of iterating multi-dimensionally over the same array or range.
+</p>
+<p>
+For instance,
+</p>
+<pre>
+  for x,y,z in [0,1]**3
+    puts [x, y, z].join(',')
+  end
+</pre>
+<p>
+produces the following output
+</p>
+<pre>
+  0,0,0
+  0,0,1
+  0,1,0
+  0,1,1
+  1,0,0
+  1,0,1
+  1,1,0
+  1,1,1
+</pre>
+<p>
+It also works with <a href="Range.html">Range</a> objects.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+
+        <div class="method-heading">
+          <span class="method-name">cartesian</span><span class="method-args">(other)</span>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Alias for <a href="Cartesian.html#M000023">x</a>
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000022" class="method-detail">
+        <a name="M000022"></a>
+
+        <div class="method-heading">
+          <a href="Cartesian.src/M000022.html" target="Code" class="method-signature"
+            onclick="popupCode('Cartesian.src/M000022.html');return false;">
+          <span class="method-name">joined_cartesian</span><span class="method-args">(other)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+<a href="Cartesian.html#M000021">Cartesian.joined_product</a> for mixin.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+
+        <div class="method-heading">
+          <a href="Cartesian.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('Cartesian.src/M000026.html');return false;">
+          <span class="method-name">left_product</span><span class="method-args">(other)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000028" class="method-detail">
+        <a name="M000028"></a>
+
+        <div class="method-heading">
+          <span class="method-name">power!</span><span class="method-args">(fixnum)</span>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Alias for #**
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
+
+        <div class="method-heading">
+          <span class="method-name">right_product</span><span class="method-args">(other)</span>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Alias for <a href="Cartesian.html#M000023">x</a>
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000023" class="method-detail">
+        <a name="M000023"></a>
+
+        <div class="method-heading">
+          <a href="Cartesian.src/M000023.html" target="Code" class="method-signature"
+            onclick="popupCode('Cartesian.src/M000023.html');return false;">
+          <span class="method-name">x</span><span class="method-args">(other)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Convenient way of iterating over the elements. Preferable when the <a
+href="Cartesian.html#M000024">cartesian</a> <a
+href="Cartesian.html#M000020">product</a> array is not needed, for the
+consumption of memory is fixed and very small, in contrast with the
+exponential memory requirements of the conventional approach.
+</p>
+<pre>
+  for row, col in (1..10).x(1..30)
+    Matrix[row, col] = row**2 + col**3
+  end
+</pre>
+<p>
+Of course, calls can be chained as in
+</p>
+<pre>
+  for x, y, z in (1..10).x(1..10).x(1..10)
+    # ... do something ...
+  end
+</pre>
+<p>
+Beware that both <tt>self</tt> and <tt>other</tt> must implement
+<tt>to_a</tt>, i.e., be convertible to array.
+</p>
+        </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>