Version 1.0.0

seantanly · Jun 26, 2015 · caa8fa5 · caa8fa5
1 parent 67a6cd3
commit caa8fa5
Show file tree

Hide file tree

Showing 10 changed files with 297 additions and 106 deletions.
diff --git a/doc/Paratize.Chunk.html b/doc/Paratize.Chunk.html
@@ -25,7 +25,7 @@
     </script>
 
     <section id="content">
-      <div class="breadcrumbs">Paratize v0.1.0 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Paratize.html">Paratize</a> &rarr; <a href="Paratize.Chunk.html">Chunk</a></div>
+      <div class="breadcrumbs">Paratize v1.0.0 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Paratize.html">Paratize</a> &rarr; <a href="Paratize.Chunk.html">Chunk</a></div>
       <h1>
         Paratize.Chunk
 
@@ -52,14 +52,22 @@ <h1>
 
 
 
-        <a href="https://github.com/seantanly/elixir-paratize/blob/master/lib/paratize/chunk.ex#L1" class="view_source">Source</a>
+        <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/chunk.ex#L1" class="view_source">Source</a>
 
 
 
         <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
         <table class="summary">
           <tr>
-  <td class="summary_signature"><a href="#exec/2">exec(fun_list, task_options \\ [])</a></td>
+  <td class="summary_signature"><a href="#exec/1">exec(fun_list)</a></td>
+
+    <td class="summary_synopsis"><p>Does parallel processing of functions via chunks, using default <a href="Paratize.TaskOptions.html"><code class="inline">Paratize.TaskOptions</code></a>.
+Returns the list of result in order</p>
+</td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#exec/2">exec(fun_list, taskoptions)</a></td>
 
     <td class="summary_synopsis"><p>Does parallel processing of functions via chunks.
 Returns the list of result in order</p>
@@ -76,45 +84,71 @@ <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link"
         <section id="functions_details" class="details_list">
           <h2>Functions</h2>
           <section class="detail">
-  <div class="detail_header" id="exec/2">
-    <span class="signature"><strong>exec(fun_list, task_options \\ [])</strong></span>
+  <div class="detail_header" id="exec/1">
+    <span class="signature"><strong>exec(fun_list)</strong></span>
     <div class="detail_header_links">
       <span class="detail_type">(function)</span>
-      <a href="#exec/2" class="detail_link" title="Link to this function">#</a>
+      <a href="#exec/1" class="detail_link" title="Link to this function">#</a>
       <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
     </div>
   </div>
 
     <p>Specs:</p>
     <ul class="spec">
 
-        <li>exec(<a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a>, <a href="Paratize.html#t:task_options/0">Paratize.task_options</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a></li>
+        <li>exec(<a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a></li>
 
     </ul>
 
   <section class="docstring">
-    <p>Does parallel processing of functions via chunks.
+    <p>Does parallel processing of functions via chunks, using default <a href="Paratize.TaskOptions.html"><code class="inline">Paratize.TaskOptions</code></a>.
 Returns the list of result in order.</p>
 <h3>Args:</h3>
 <ul>
 <li>fun_list - list of functions to execute in parallel.
 </li>
-<li>task_options - Keyword of options.
-</li>
 </ul>
-<h4>task_options:</h4>
+<p>iex&gt; [fn -> 1 end, {:b, fn -> 2 end}, fn -> 3 end] |&gt; Paratize.Chunk.exec(%Paratize.TaskOptions{mode: :chunk})
+[1, {:b,2}, 3]</p>
+
+  </section>
+
+    <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/chunk.ex#L20" class="view_source">Source</a>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="exec/2">
+    <span class="signature"><strong>exec(fun_list, taskoptions)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#exec/2" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+    <p>Specs:</p>
+    <ul class="spec">
+
+        <li>exec(<a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a>, <a href="Paratize.TaskOptions.html#t:t/0">Paratize.TaskOptions.t</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a></li>
+
+    </ul>
+
+  <section class="docstring">
+    <p>Does parallel processing of functions via chunks.
+Returns the list of result in order.</p>
+<h3>Args:</h3>
 <ul>
-<li>size - number of workers, default: fun_list count. :schedulers will use the number of system cores.
+<li>fun_list - list of functions to execute in parallel.
 </li>
-<li>timeout - timeout in ms, integer, default: 5000, exit(:timeout,…) if no result is return by any of the workers within the period.
+<li>task_options - <a href="Paratize.TaskOptions.html"><code class="inline">Paratize.TaskOptions</code></a>
 </li>
 </ul>
 <p>iex&gt; [fn -> 1 end, {:b, fn -> 2 end}, fn -> 3 end] |&gt; Paratize.Chunk.exec
 [1, {:b,2}, 3]</p>
 
   </section>
 
-    <a href="https://github.com/seantanly/elixir-paratize/blob/master/lib/paratize/chunk.ex#L24" class="view_source">Source</a>
+    <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/chunk.ex#L35" class="view_source">Source</a>
 
 </section>
 

diff --git a/doc/Paratize.Pool.html b/doc/Paratize.Pool.html
@@ -25,7 +25,7 @@
     </script>
 
     <section id="content">
-      <div class="breadcrumbs">Paratize v0.1.0 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Paratize.html">Paratize</a> &rarr; <a href="Paratize.Pool.html">Pool</a></div>
+      <div class="breadcrumbs">Paratize v1.0.0 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Paratize.html">Paratize</a> &rarr; <a href="Paratize.Pool.html">Pool</a></div>
       <h1>
         Paratize.Pool
 
@@ -52,14 +52,22 @@ <h1>
 
 
 
-        <a href="https://github.com/seantanly/elixir-paratize/blob/master/lib/paratize/pool.ex#L1" class="view_source">Source</a>
+        <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/pool.ex#L1" class="view_source">Source</a>
 
 
 
         <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
         <table class="summary">
           <tr>
-  <td class="summary_signature"><a href="#exec/2">exec(fun_list, task_options \\ [])</a></td>
+  <td class="summary_signature"><a href="#exec/1">exec(fun_list)</a></td>
+
+    <td class="summary_synopsis"><p>Does parallel processing of functions via pool of workers, using default <a href="Paratize.TaskOptions.html"><code class="inline">Paratize.TaskOptions</code></a>.
+Returns the list of result in order</p>
+</td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#exec/2">exec(fun_list, taskoptions)</a></td>
 
     <td class="summary_synopsis"><p>Does parallel processing of functions via pool of workers.
 Returns the list of result in order</p>
@@ -76,45 +84,71 @@ <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link"
         <section id="functions_details" class="details_list">
           <h2>Functions</h2>
           <section class="detail">
-  <div class="detail_header" id="exec/2">
-    <span class="signature"><strong>exec(fun_list, task_options \\ [])</strong></span>
+  <div class="detail_header" id="exec/1">
+    <span class="signature"><strong>exec(fun_list)</strong></span>
     <div class="detail_header_links">
       <span class="detail_type">(function)</span>
-      <a href="#exec/2" class="detail_link" title="Link to this function">#</a>
+      <a href="#exec/1" class="detail_link" title="Link to this function">#</a>
       <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
     </div>
   </div>
 
     <p>Specs:</p>
     <ul class="spec">
 
-        <li>exec(<a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a>, <a href="Paratize.html#t:task_options/0">Paratize.task_options</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a></li>
+        <li>exec(<a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a></li>
 
     </ul>
 
   <section class="docstring">
-    <p>Does parallel processing of functions via pool of workers.
+    <p>Does parallel processing of functions via pool of workers, using default <a href="Paratize.TaskOptions.html"><code class="inline">Paratize.TaskOptions</code></a>.
 Returns the list of result in order.</p>
 <h3>Args:</h3>
 <ul>
 <li>fun_list - list of functions to execute in parallel.
 </li>
-<li>task_options - Keyword of options.
-</li>
 </ul>
-<h4>task_options:</h4>
+<p>iex&gt; [fn -> 1 end, {:b, fn -> 2 end}, fn -> 3 end] |&gt; Paratize.Pool.exec
+[1, {:b,2}, 3]</p>
+
+  </section>
+
+    <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/pool.ex#L20" class="view_source">Source</a>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="exec/2">
+    <span class="signature"><strong>exec(fun_list, taskoptions)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#exec/2" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+    <p>Specs:</p>
+    <ul class="spec">
+
+        <li>exec(<a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a>, <a href="Paratize.TaskOptions.html#t:t/0">Paratize.TaskOptions.t</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/List.html#t:t/0">List.t</a></li>
+
+    </ul>
+
+  <section class="docstring">
+    <p>Does parallel processing of functions via pool of workers.
+Returns the list of result in order.</p>
+<h3>Args:</h3>
 <ul>
-<li>size - number of workers, default: fun_list count. :schedulers will use the number of system cores.
+<li>fun_list - list of functions to execute in parallel.
 </li>
-<li>timeout - timeout in ms, integer, default: 5000, exit(:timeout,…) if no result is return by any of the workers within the period.
+<li>task_options - <a href="Paratize.TaskOptions.html"><code class="inline">Paratize.TaskOptions</code></a>
 </li>
 </ul>
-<p>iex&gt; [fn -> 1 end, {:b, fn -> 2 end}, fn -> 3 end] |&gt; Paratize.Pool.exec
+<p>iex&gt; [fn -> 1 end, {:b, fn -> 2 end}, fn -> 3 end] |&gt; Paratize.Pool.exec(%Paratize.TaskOptions{mode: :pool})
 [1, {:b,2}, 3]</p>
 
   </section>
 
-    <a href="https://github.com/seantanly/elixir-paratize/blob/master/lib/paratize/pool.ex#L24" class="view_source">Source</a>
+    <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/pool.ex#L35" class="view_source">Source</a>
 
 </section>
 

diff --git a/doc/Paratize.TaskOptions.html b/doc/Paratize.TaskOptions.html
@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Paratize.TaskOptions</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="css/elixir.css" type="text/css" media="screen" charset="utf-8" />
+    <script type="text/javascript" charset="utf-8">
+      relpath = '';
+      if (relpath != '') relpath += '/';
+    </script>
+
+    <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+    <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+    <script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
+    <script type="text/javascript" charset="utf-8">
+      hljs.initHighlightingOnLoad();
+      hljs.configure({languages: []}); //disable autodetect
+    </script>
+  </head>
+
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <section id="content">
+      <div class="breadcrumbs">Paratize v1.0.0 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="Paratize.html">Paratize</a> &rarr; <a href="Paratize.TaskOptions.html">TaskOptions</a></div>
+      <h1>
+        Paratize.TaskOptions
+
+      </h1>
+
+      <ul class="summary_links">
+
+          <li><a href="#summary">Summary</a></li>
+
+
+
+          <li><a href="#functions_details">Functions</a></li>
+
+
+
+      </ul>
+
+
+        <section id="moduledoc" class="docstring">
+          <p>Struct holding the configurations for executing the workload in parallel.</p>
+
+        </section>
+
+
+
+        <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/task_options.ex#L1" class="view_source">Source</a>
+
+
+
+        <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
+        <table class="summary">
+          <tr>
+  <td class="summary_signature"><a href="#__struct__/0">__struct__()</a></td>
+
+    <td class="summary_synopsis"><ul>
+<li>mode - :chunk | :pool (default :pool).
+</li>
+<li>size - number of workers, default: the number of CPU cores.
+</li>
+<li>timeout - timeout in ms, integer, default: 5000, exit(:timeout,…) if no result is return by any of the workers within the period
+</li>
+</ul>
+</td>
+
+</tr>
+
+        </table>
+
+
+
+
+
+        <section id="functions_details" class="details_list">
+          <h2>Functions</h2>
+          <section class="detail">
+  <div class="detail_header" id="__struct__/0">
+    <span class="signature"><strong>__struct__()</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#__struct__/0" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+    <p>Specs:</p>
+    <ul class="spec">
+
+        <li>__struct__ :: %Paratize.TaskOptions{mode: term, size: term, timeout: term}</li>
+
+    </ul>
+
+  <section class="docstring">
+    <ul>
+<li>mode - :chunk | :pool (default :pool).
+</li>
+<li>size - number of workers, default: the number of CPU cores.
+</li>
+<li>timeout - timeout in ms, integer, default: 5000, exit(:timeout,…) if no result is return by any of the workers within the period.
+</li>
+</ul>
+
+  </section>
+
+    <a href="https://github.com/seantanly/elixir-paratize/blob/v1.0.0/lib/paratize/task_options.ex#L11" class="view_source">Source</a>
+
+</section>
+
+        </section>
+
+
+
+
+
+    </section>
+  </body>
+</html>