mdarray 0.4.3.pre-java → 0.5.0-java
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +82 -14
- data/Rakefile +8 -2
- data/doc/BinaryOperator.html +227 -0
- data/doc/BitwiseOperators.html +135 -0
- data/doc/BooleanFunctions.html +135 -0
- data/doc/BooleanMDArray.html +193 -0
- data/doc/ByteMDArray.html +271 -0
- data/doc/Colt.html +269 -0
- data/doc/ComparisonOperators.html +135 -0
- data/doc/Const.html +490 -0
- data/doc/Csv.html +589 -0
- data/doc/DDescriptive.html +4373 -0
- data/doc/DoubleMDArray.html +555 -0
- data/doc/DoubleStatList.html +256 -0
- data/doc/FastBinaryOperator.html +743 -0
- data/doc/FastBoolean.html +512 -0
- data/doc/FastUnaryOperator.html +583 -0
- data/doc/FloatMDArray.html +237 -0
- data/doc/FunctionCreation.html +520 -0
- data/doc/FunctionMap.html +813 -0
- data/doc/GenericFunctions.html +135 -0
- data/doc/IntMDArray.html +259 -0
- data/doc/LongMDArray.html +257 -0
- data/doc/MDArray.html +9639 -0
- data/doc/MDArray/Counter.html +2767 -0
- data/doc/MDArray/IteratorFast.html +872 -0
- data/doc/MDArray/IteratorFastBoolean.html +384 -0
- data/doc/MDArray/IteratorFastByte.html +373 -0
- data/doc/MDArray/IteratorFastChar.html +384 -0
- data/doc/MDArray/IteratorFastDouble.html +384 -0
- data/doc/MDArray/IteratorFastFloat.html +384 -0
- data/doc/MDArray/IteratorFastInt.html +384 -0
- data/doc/MDArray/IteratorFastLong.html +384 -0
- data/doc/MDArray/IteratorFastShort.html +384 -0
- data/doc/MDArrayTest.html +125 -0
- data/doc/NonNumericalMDArray.html +177 -0
- data/doc/NumericFunctions.html +297 -0
- data/doc/NumericalMDArray.html +278 -0
- data/doc/Operator.html +826 -0
- data/doc/Proc.html +1097 -0
- data/doc/RubyBinaryOperator.html +526 -0
- data/doc/RubyFunctions.html +232 -0
- data/doc/RubyMath.html +135 -0
- data/doc/RubyStats.html +135 -0
- data/doc/RubyUnaryOperator.html +510 -0
- data/doc/ShortMDArray.html +267 -0
- data/doc/StatList.html +1176 -0
- data/doc/StringMDArray.html +181 -0
- data/doc/StructureMDArray.html +181 -0
- data/doc/UnaryOperator.html +227 -0
- data/doc/UserFunction.html +297 -0
- data/doc/_index.html +467 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +338 -0
- data/doc/file.README.html +173 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +173 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +2524 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/colt/colt.rb +56 -0
- data/lib/colt/colt_mdarray.rb +95 -0
- data/lib/colt/double_descriptive.rb +636 -0
- data/lib/colt/probability.rb +12 -0
- data/lib/colt/stat_list.rb +192 -0
- data/lib/env.rb +5 -1
- data/lib/mdarray.rb +5 -0
- data/lib/mdarray/access.rb +2 -2
- data/lib/mdarray/creation.rb +34 -19
- data/lib/mdarray/csv.rb +61 -0
- data/lib/mdarray/fast_operators.rb +241 -0
- data/lib/mdarray/operators.rb +18 -0
- data/lib/mdarray/ruby_operators.rb +2 -18
- data/lib/mdarray/ruby_stats.rb +1 -1
- data/lib/mdarray/views.rb +8 -8
- data/target/helper.jar +0 -0
- data/test/colt/VALE3.csv +3437 -0
- data/test/colt/VALE3.xlsx +0 -0
- data/test/colt/VALE3_short-err.csv +20 -0
- data/test/colt/VALE3_short.csv +20 -0
- data/test/colt/VALE3_short.xlsx +0 -0
- data/test/colt/test_complete.rb +25 -0
- data/test/colt/test_stat_list.rb +128 -0
- data/test/colt/test_statistics.rb +114 -0
- data/test/complete.rb +25 -0
- data/test/env.rb +54 -30
- data/test/{arithmetic_casting.rb → mdarray/arithmetic_casting.rb} +0 -0
- data/test/{test_access.rb → mdarray/test_access.rb} +0 -0
- data/test/{test_boolean.rb → mdarray/test_boolean.rb} +0 -2
- data/test/{test_comparison.rb → mdarray/test_comparison.rb} +0 -0
- data/test/{test_complete.rb → mdarray/test_complete.rb} +3 -14
- data/test/{test_counter.rb → mdarray/test_counter.rb} +0 -0
- data/test/{test_creation.rb → mdarray/test_creation.rb} +0 -0
- data/test/{test_error.rb → mdarray/test_error.rb} +8 -5
- data/test/{test_operator.rb → mdarray/test_operator.rb} +6 -2
- data/test/{test_speed.rb → mdarray/test_performance.rb} +74 -39
- data/test/{test_printing.rb → mdarray/test_printing.rb} +0 -1
- data/test/{test_shape.rb → mdarray/test_shape.rb} +0 -0
- data/test/mdarray/test_statistics.rb +80 -0
- data/test/{test_trigonometry.rb → mdarray/test_trigonometry.rb} +0 -0
- data/test/{test_views.rb → mdarray/test_views.rb} +0 -0
- data/vendor/parallelcolt-0.10.0.jar +0 -0
- data/version.rb +1 -1
- metadata +122 -39
- data/test/test_lazy.rb +0 -52
- data/test/test_statistics.rb +0 -38
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '';
|
|
20
|
+
framesUrl = "frames.html#!" + escape(window.location.href);
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="_index.html">Index</a> »
|
|
35
|
+
<span class="title">File: README</span>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">
|
|
42
|
+
|
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
|
44
|
+
href="class_list.html">
|
|
45
|
+
Class List
|
|
46
|
+
</a>
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
|
49
|
+
href="method_list.html">
|
|
50
|
+
Method List
|
|
51
|
+
</a>
|
|
52
|
+
|
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
|
54
|
+
href="file_list.html">
|
|
55
|
+
File List
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><div id='filecontents'><h1 id="mdarray">MDArray</h1>
|
|
65
|
+
|
|
66
|
+
<p>MDArray is a multi dimensional array implemented for JRuby inspired by NumPy (www.numpy.org)
|
|
67
|
+
and Narray (narray.rubyforge.org) by Masahiro Tanaka. MDArray stands on the shoulders of
|
|
68
|
+
Java-NetCDF and Parallel Colt.</p>
|
|
69
|
+
|
|
70
|
+
<p>NetCDF-Java Library is a Java interface to NetCDF files, as well as to many other types of
|
|
71
|
+
scientific data formats. It is developed and distributed by Unidata (http://www.unidata.ucar.edu). </p>
|
|
72
|
+
|
|
73
|
+
<p>Parallel Colt (sites.google.com/site/piotrwendykier/software/parallelcolt) is a multithreaded
|
|
74
|
+
version of Colt (http://acs.lbl.gov/software/colt/). Colt provides a set of Open Source
|
|
75
|
+
Libraries for High Performance Scientific and Technical Computing in Java. Scientific
|
|
76
|
+
and technical computing is characterized by demanding problem sizes and a need for high
|
|
77
|
+
performance at reasonably small memory footprint.</p>
|
|
78
|
+
|
|
79
|
+
<h1 id="mdarray-and-sciruby">MDArray and SciRuby</h1>
|
|
80
|
+
|
|
81
|
+
<p>MDArray subscribes fully to the SciRuby Manifesto (http://sciruby.com/). </p>
|
|
82
|
+
|
|
83
|
+
<p>“Ruby has for some time had no equivalent to the beautifully constructed NumPy, SciPy,
|
|
84
|
+
and matplotlib libraries for Python. </p>
|
|
85
|
+
|
|
86
|
+
<p>We believe that the time for a Ruby science and visualization package has come. Sometimes
|
|
87
|
+
when a solution of sugar and water becomes super-saturated, from it precipitates a pure,
|
|
88
|
+
delicious, and diabetes-inducing crystal of sweetness, induced by no more than the tap
|
|
89
|
+
of a finger. So is occurring now, we believe, with numeric and visualization libraries for Ruby.”</p>
|
|
90
|
+
|
|
91
|
+
<h1 id="main-properties">Main properties</h1>
|
|
92
|
+
|
|
93
|
+
<ul>
|
|
94
|
+
<li>Homogeneous multidimensional array, a table of elements (usually numbers), all of the
|
|
95
|
+
same type, indexed by a tuple of positive integers;</li>
|
|
96
|
+
<li>Easy calculation for large numerical multi dimensional arrays;</li>
|
|
97
|
+
<li>Basic types are: boolean, byte, short, int, long, float, double, string, structure;</li>
|
|
98
|
+
<li>Based on JRuby, which allows importing Java libraries. Version 0.4.0 only imports
|
|
99
|
+
Java-NetCDF;</li>
|
|
100
|
+
<li>Operator: +,-,*,/,%,**, >, >=, etc.</li>
|
|
101
|
+
<li>Functions: abs, ceil, floor, truncate, is_zero, square, cube, fourth;</li>
|
|
102
|
+
<li>
|
|
103
|
+
<table>
|
|
104
|
+
<tbody>
|
|
105
|
+
<tr>
|
|
106
|
+
<td>Binary Operators: &,</td>
|
|
107
|
+
<td>, ^, ~ (binary_ones_complement), «, »;</td>
|
|
108
|
+
</tr>
|
|
109
|
+
</tbody>
|
|
110
|
+
</table>
|
|
111
|
+
</li>
|
|
112
|
+
<li>Ruby Math functions: acos, acosh, asin, asinh, atan, atan2, atanh, cbrt, cos, erf, exp,
|
|
113
|
+
gamma, hypot, ldexp, log, log10, log2, sin, sinh, sqrt, tan, tanh, neg;</li>
|
|
114
|
+
<li>Boolean operations on boolean arrays: and, or, not;</li>
|
|
115
|
+
<li>Fast descriptive statistics from Parallel Colt (complete list found bellow);</li>
|
|
116
|
+
<li>Easy manipulation of arrays: reshape, reduce dimension, permute, section, slice, etc.</li>
|
|
117
|
+
<li>Reading of two dimensional arrays from CSV files (mainly for debugging and simple
|
|
118
|
+
testing purposes);</li>
|
|
119
|
+
<li>StatList: a list that can grow/shrink and that can compute Parallel Colt descriptive
|
|
120
|
+
statistics. </li>
|
|
121
|
+
</ul>
|
|
122
|
+
|
|
123
|
+
<h1 id="descriptive-statistics-methods">Descriptive statistics methods</h1>
|
|
124
|
+
|
|
125
|
+
<p>auto_correlation, correlation, covariance, durbin_watson, frequencies, geometric_mean,
|
|
126
|
+
harmonic_mean, kurtosis, lag1, max, mean, mean_deviation, median, min, moment, moment3,
|
|
127
|
+
moment4, pooled_mean, pooled_variance, product, quantile, quantile_inverse,
|
|
128
|
+
rank_interpolated, rms, sample_covariance, sample_kurtosis,
|
|
129
|
+
sample_kurtosis_standard_error, sample_skew, sample_skew_standard_error,
|
|
130
|
+
sample_standard_deviation, sample_variance, sample_weighted_variance, skew, split,<br />
|
|
131
|
+
standard_deviation, standard_error, sum, sum_of_inversions, sum_of_logarithms,
|
|
132
|
+
sum_of_powers, sum_of_power_deviations, sum_of_squares, sum_of_squared_deviations,
|
|
133
|
+
trimmed_mean, variance, weighted_mean, weighted_rms, weighted_sums, winsorized_mean.</p>
|
|
134
|
+
|
|
135
|
+
<h1 id="installation-and-download">Installation and download</h1>
|
|
136
|
+
|
|
137
|
+
<ul>
|
|
138
|
+
<li>Install Jruby</li>
|
|
139
|
+
<li>jruby –S gem install mdarray</li>
|
|
140
|
+
</ul>
|
|
141
|
+
|
|
142
|
+
<h1 id="contributors">Contributors</h1>
|
|
143
|
+
|
|
144
|
+
<ul>
|
|
145
|
+
<li>Contributors are welcome.</li>
|
|
146
|
+
</ul>
|
|
147
|
+
|
|
148
|
+
<h1 id="homepages">Homepages</h1>
|
|
149
|
+
|
|
150
|
+
<ul>
|
|
151
|
+
<li>http://rubygems.org/gems/mdarray</li>
|
|
152
|
+
<li>https://github.com/rbotafogo/mdarray/wiki</li>
|
|
153
|
+
</ul>
|
|
154
|
+
|
|
155
|
+
<h1 id="history">HISTORY</h1>
|
|
156
|
+
|
|
157
|
+
<ul>
|
|
158
|
+
<li>16/05/2013: Version 0.5.0: All loops transfered to Java with over 50% performance
|
|
159
|
+
improvement. Descriptive statistics from Parallel Colt.</li>
|
|
160
|
+
<li>19/04/2013: Version 0.4.3: Fixes a simple (but fatal bug). No new features</li>
|
|
161
|
+
<li>17/04/2013: Version 0.4.2: Adds simple statistics and boolean operators</li>
|
|
162
|
+
<li>05/05/2013: Version 0.4.0: Initial release</li>
|
|
163
|
+
</ul>
|
|
164
|
+
</div></div>
|
|
165
|
+
|
|
166
|
+
<div id="footer">
|
|
167
|
+
Generated on Thu May 16 12:48:34 2013 by
|
|
168
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
169
|
+
0.8.5.2 (ruby-1.9.3).
|
|
170
|
+
</div>
|
|
171
|
+
|
|
172
|
+
</body>
|
|
173
|
+
</html>
|
data/doc/file_list.html
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<base id="base_target" target="_parent" />
|
|
19
|
+
</head>
|
|
20
|
+
<body>
|
|
21
|
+
<script type="text/javascript" charset="utf-8">
|
|
22
|
+
if (window.top.frames.main) {
|
|
23
|
+
document.getElementById('base_target').target = 'main';
|
|
24
|
+
document.body.className = 'frames';
|
|
25
|
+
}
|
|
26
|
+
</script>
|
|
27
|
+
<div id="content">
|
|
28
|
+
<h1 id="full_list_header">File List</h1>
|
|
29
|
+
<div id="nav">
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="class_list.html">
|
|
32
|
+
Classes
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="method_list.html">
|
|
36
|
+
Methods
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
<span><a target="_self" href="file_list.html">
|
|
40
|
+
Files
|
|
41
|
+
</a></span>
|
|
42
|
+
|
|
43
|
+
</div>
|
|
44
|
+
<div id="search">Search: <input type="text" /></div>
|
|
45
|
+
|
|
46
|
+
<ul id="full_list" class="file">
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<li class="r1"><a href="index.html" title="README">README</a></li>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</ul>
|
|
53
|
+
</div>
|
|
54
|
+
</body>
|
|
55
|
+
</html>
|
data/doc/frames.html
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
|
3
|
+
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|
7
|
+
<title>Documentation by YARD 0.8.5.2</title>
|
|
8
|
+
</head>
|
|
9
|
+
<script type="text/javascript" charset="utf-8">
|
|
10
|
+
window.onload = function() {
|
|
11
|
+
var match = window.location.hash.match(/^#!(.+)/);
|
|
12
|
+
var name = 'index.html';
|
|
13
|
+
if (match) {
|
|
14
|
+
name = unescape(match[1]);
|
|
15
|
+
}
|
|
16
|
+
document.writeln('<frameset cols="20%,*">' +
|
|
17
|
+
'<frame name="list" src="class_list.html" />' +
|
|
18
|
+
'<frame name="main" src="' + name + '" />' +
|
|
19
|
+
'</frameset>');
|
|
20
|
+
}
|
|
21
|
+
</script>
|
|
22
|
+
<noscript>
|
|
23
|
+
<frameset cols="20%,*">
|
|
24
|
+
<frame name="list" src="class_list.html" />
|
|
25
|
+
<frame name="main" src="index.html" />
|
|
26
|
+
</frameset>
|
|
27
|
+
</noscript>
|
|
28
|
+
</html>
|
data/doc/index.html
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '';
|
|
20
|
+
framesUrl = "frames.html#!" + escape(window.location.href);
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="_index.html">Index</a> »
|
|
35
|
+
<span class="title">File: README</span>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">
|
|
42
|
+
|
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
|
44
|
+
href="class_list.html">
|
|
45
|
+
Class List
|
|
46
|
+
</a>
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
|
49
|
+
href="method_list.html">
|
|
50
|
+
Method List
|
|
51
|
+
</a>
|
|
52
|
+
|
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
|
54
|
+
href="file_list.html">
|
|
55
|
+
File List
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><div id='filecontents'><h1 id="mdarray">MDArray</h1>
|
|
65
|
+
|
|
66
|
+
<p>MDArray is a multi dimensional array implemented for JRuby inspired by NumPy (www.numpy.org)
|
|
67
|
+
and Narray (narray.rubyforge.org) by Masahiro Tanaka. MDArray stands on the shoulders of
|
|
68
|
+
Java-NetCDF and Parallel Colt.</p>
|
|
69
|
+
|
|
70
|
+
<p>NetCDF-Java Library is a Java interface to NetCDF files, as well as to many other types of
|
|
71
|
+
scientific data formats. It is developed and distributed by Unidata (http://www.unidata.ucar.edu). </p>
|
|
72
|
+
|
|
73
|
+
<p>Parallel Colt (sites.google.com/site/piotrwendykier/software/parallelcolt) is a multithreaded
|
|
74
|
+
version of Colt (http://acs.lbl.gov/software/colt/). Colt provides a set of Open Source
|
|
75
|
+
Libraries for High Performance Scientific and Technical Computing in Java. Scientific
|
|
76
|
+
and technical computing is characterized by demanding problem sizes and a need for high
|
|
77
|
+
performance at reasonably small memory footprint.</p>
|
|
78
|
+
|
|
79
|
+
<h1 id="mdarray-and-sciruby">MDArray and SciRuby</h1>
|
|
80
|
+
|
|
81
|
+
<p>MDArray subscribes fully to the SciRuby Manifesto (http://sciruby.com/). </p>
|
|
82
|
+
|
|
83
|
+
<p>“Ruby has for some time had no equivalent to the beautifully constructed NumPy, SciPy,
|
|
84
|
+
and matplotlib libraries for Python. </p>
|
|
85
|
+
|
|
86
|
+
<p>We believe that the time for a Ruby science and visualization package has come. Sometimes
|
|
87
|
+
when a solution of sugar and water becomes super-saturated, from it precipitates a pure,
|
|
88
|
+
delicious, and diabetes-inducing crystal of sweetness, induced by no more than the tap
|
|
89
|
+
of a finger. So is occurring now, we believe, with numeric and visualization libraries for Ruby.”</p>
|
|
90
|
+
|
|
91
|
+
<h1 id="main-properties">Main properties</h1>
|
|
92
|
+
|
|
93
|
+
<ul>
|
|
94
|
+
<li>Homogeneous multidimensional array, a table of elements (usually numbers), all of the
|
|
95
|
+
same type, indexed by a tuple of positive integers;</li>
|
|
96
|
+
<li>Easy calculation for large numerical multi dimensional arrays;</li>
|
|
97
|
+
<li>Basic types are: boolean, byte, short, int, long, float, double, string, structure;</li>
|
|
98
|
+
<li>Based on JRuby, which allows importing Java libraries. Version 0.4.0 only imports
|
|
99
|
+
Java-NetCDF;</li>
|
|
100
|
+
<li>Operator: +,-,*,/,%,**, >, >=, etc.</li>
|
|
101
|
+
<li>Functions: abs, ceil, floor, truncate, is_zero, square, cube, fourth;</li>
|
|
102
|
+
<li>
|
|
103
|
+
<table>
|
|
104
|
+
<tbody>
|
|
105
|
+
<tr>
|
|
106
|
+
<td>Binary Operators: &,</td>
|
|
107
|
+
<td>, ^, ~ (binary_ones_complement), «, »;</td>
|
|
108
|
+
</tr>
|
|
109
|
+
</tbody>
|
|
110
|
+
</table>
|
|
111
|
+
</li>
|
|
112
|
+
<li>Ruby Math functions: acos, acosh, asin, asinh, atan, atan2, atanh, cbrt, cos, erf, exp,
|
|
113
|
+
gamma, hypot, ldexp, log, log10, log2, sin, sinh, sqrt, tan, tanh, neg;</li>
|
|
114
|
+
<li>Boolean operations on boolean arrays: and, or, not;</li>
|
|
115
|
+
<li>Fast descriptive statistics from Parallel Colt (complete list found bellow);</li>
|
|
116
|
+
<li>Easy manipulation of arrays: reshape, reduce dimension, permute, section, slice, etc.</li>
|
|
117
|
+
<li>Reading of two dimensional arrays from CSV files (mainly for debugging and simple
|
|
118
|
+
testing purposes);</li>
|
|
119
|
+
<li>StatList: a list that can grow/shrink and that can compute Parallel Colt descriptive
|
|
120
|
+
statistics. </li>
|
|
121
|
+
</ul>
|
|
122
|
+
|
|
123
|
+
<h1 id="descriptive-statistics-methods">Descriptive statistics methods</h1>
|
|
124
|
+
|
|
125
|
+
<p>auto_correlation, correlation, covariance, durbin_watson, frequencies, geometric_mean,
|
|
126
|
+
harmonic_mean, kurtosis, lag1, max, mean, mean_deviation, median, min, moment, moment3,
|
|
127
|
+
moment4, pooled_mean, pooled_variance, product, quantile, quantile_inverse,
|
|
128
|
+
rank_interpolated, rms, sample_covariance, sample_kurtosis,
|
|
129
|
+
sample_kurtosis_standard_error, sample_skew, sample_skew_standard_error,
|
|
130
|
+
sample_standard_deviation, sample_variance, sample_weighted_variance, skew, split,<br />
|
|
131
|
+
standard_deviation, standard_error, sum, sum_of_inversions, sum_of_logarithms,
|
|
132
|
+
sum_of_powers, sum_of_power_deviations, sum_of_squares, sum_of_squared_deviations,
|
|
133
|
+
trimmed_mean, variance, weighted_mean, weighted_rms, weighted_sums, winsorized_mean.</p>
|
|
134
|
+
|
|
135
|
+
<h1 id="installation-and-download">Installation and download</h1>
|
|
136
|
+
|
|
137
|
+
<ul>
|
|
138
|
+
<li>Install Jruby</li>
|
|
139
|
+
<li>jruby –S gem install mdarray</li>
|
|
140
|
+
</ul>
|
|
141
|
+
|
|
142
|
+
<h1 id="contributors">Contributors</h1>
|
|
143
|
+
|
|
144
|
+
<ul>
|
|
145
|
+
<li>Contributors are welcome.</li>
|
|
146
|
+
</ul>
|
|
147
|
+
|
|
148
|
+
<h1 id="homepages">Homepages</h1>
|
|
149
|
+
|
|
150
|
+
<ul>
|
|
151
|
+
<li>http://rubygems.org/gems/mdarray</li>
|
|
152
|
+
<li>https://github.com/rbotafogo/mdarray/wiki</li>
|
|
153
|
+
</ul>
|
|
154
|
+
|
|
155
|
+
<h1 id="history">HISTORY</h1>
|
|
156
|
+
|
|
157
|
+
<ul>
|
|
158
|
+
<li>16/05/2013: Version 0.5.0: All loops transfered to Java with over 50% performance
|
|
159
|
+
improvement. Descriptive statistics from Parallel Colt.</li>
|
|
160
|
+
<li>19/04/2013: Version 0.4.3: Fixes a simple (but fatal bug). No new features</li>
|
|
161
|
+
<li>17/04/2013: Version 0.4.2: Adds simple statistics and boolean operators</li>
|
|
162
|
+
<li>05/05/2013: Version 0.4.0: Initial release</li>
|
|
163
|
+
</ul>
|
|
164
|
+
</div></div>
|
|
165
|
+
|
|
166
|
+
<div id="footer">
|
|
167
|
+
Generated on Thu May 16 12:48:34 2013 by
|
|
168
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
169
|
+
0.8.5.2 (ruby-1.9.3).
|
|
170
|
+
</div>
|
|
171
|
+
|
|
172
|
+
</body>
|
|
173
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
function createSourceLinks() {
|
|
2
|
+
$('.method_details_list .source_code').
|
|
3
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
4
|
+
$('.toggleSource').toggle(function() {
|
|
5
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
6
|
+
$(this).text("Hide source");
|
|
7
|
+
},
|
|
8
|
+
function() {
|
|
9
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
10
|
+
$(this).text("View source");
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
function createDefineLinks() {
|
|
15
|
+
var tHeight = 0;
|
|
16
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
17
|
+
$('.toggleDefines').toggle(function() {
|
|
18
|
+
tHeight = $(this).parent().prev().height();
|
|
19
|
+
$(this).prev().show();
|
|
20
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
21
|
+
$(this).text("(less)");
|
|
22
|
+
},
|
|
23
|
+
function() {
|
|
24
|
+
$(this).prev().hide();
|
|
25
|
+
$(this).parent().prev().height(tHeight);
|
|
26
|
+
$(this).text("more...");
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function createFullTreeLinks() {
|
|
31
|
+
var tHeight = 0;
|
|
32
|
+
$('.inheritanceTree').toggle(function() {
|
|
33
|
+
tHeight = $(this).parent().prev().height();
|
|
34
|
+
$(this).parent().toggleClass('showAll');
|
|
35
|
+
$(this).text("(hide)");
|
|
36
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
37
|
+
},
|
|
38
|
+
function() {
|
|
39
|
+
$(this).parent().toggleClass('showAll');
|
|
40
|
+
$(this).parent().prev().height(tHeight);
|
|
41
|
+
$(this).text("show all");
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function fixBoxInfoHeights() {
|
|
46
|
+
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
|
47
|
+
$(this).prev().height($(this).height());
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameLinks() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
function toggleSearchFrame(id, link) {
|
|
59
|
+
var frame = $('#search_frame');
|
|
60
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
61
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
|
62
|
+
frame.slideUp(100);
|
|
63
|
+
$('#search a').removeClass('active inactive');
|
|
64
|
+
}
|
|
65
|
+
else {
|
|
66
|
+
$(id).addClass('active').removeClass('inactive');
|
|
67
|
+
frame.attr('src', link).slideDown(100);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
function linkSummaries() {
|
|
72
|
+
$('.summary_signature').click(function() {
|
|
73
|
+
document.location = $(this).find('a').attr('href');
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
function framesInit() {
|
|
78
|
+
if (hasFrames) {
|
|
79
|
+
document.body.className = 'frames';
|
|
80
|
+
$('#menu .noframes a').attr('href', document.location);
|
|
81
|
+
window.top.document.title = $('html head title').text();
|
|
82
|
+
}
|
|
83
|
+
else {
|
|
84
|
+
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
function keyboardShortcuts() {
|
|
89
|
+
if (window.top.frames.main) return;
|
|
90
|
+
$(document).keypress(function(evt) {
|
|
91
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
|
92
|
+
if (typeof evt.target !== "undefined" &&
|
|
93
|
+
(evt.target.nodeName == "INPUT" ||
|
|
94
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
|
95
|
+
switch (evt.charCode) {
|
|
96
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
|
97
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
|
98
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
|
99
|
+
default: break;
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
function summaryToggle() {
|
|
105
|
+
$('.summary_toggle').click(function() {
|
|
106
|
+
if (localStorage) {
|
|
107
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
108
|
+
}
|
|
109
|
+
$('.summary_toggle').each(function() {
|
|
110
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
111
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
112
|
+
if (next.hasClass('compact')) {
|
|
113
|
+
next.toggle();
|
|
114
|
+
next.nextAll('ul.summary').first().toggle();
|
|
115
|
+
}
|
|
116
|
+
else if (next.hasClass('summary')) {
|
|
117
|
+
var list = $('<ul class="summary compact" />');
|
|
118
|
+
list.html(next.html());
|
|
119
|
+
list.find('.summary_desc, .note').remove();
|
|
120
|
+
list.find('a').each(function() {
|
|
121
|
+
$(this).html($(this).find('strong').html());
|
|
122
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
123
|
+
});
|
|
124
|
+
next.before(list);
|
|
125
|
+
next.toggle();
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
return false;
|
|
129
|
+
});
|
|
130
|
+
if (localStorage) {
|
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
132
|
+
$('.summary_toggle').first().click();
|
|
133
|
+
}
|
|
134
|
+
else localStorage.summaryCollapsed = "expand";
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
function fixOutsideWorldLinks() {
|
|
139
|
+
$('a').each(function() {
|
|
140
|
+
if (window.location.host != this.host) this.target = '_parent';
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
function generateTOC() {
|
|
145
|
+
if ($('#filecontents').length === 0) return;
|
|
146
|
+
var _toc = $('<ol class="top"></ol>');
|
|
147
|
+
var show = false;
|
|
148
|
+
var toc = _toc;
|
|
149
|
+
var counter = 0;
|
|
150
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
151
|
+
var i;
|
|
152
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
153
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
154
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
155
|
+
$(tags.join(', ')).each(function() {
|
|
156
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
157
|
+
if (this.id == "filecontents") return;
|
|
158
|
+
show = true;
|
|
159
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
160
|
+
if (this.id.length === 0) {
|
|
161
|
+
var proposedId = $(this).attr('toc-id');
|
|
162
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
163
|
+
else {
|
|
164
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
165
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
166
|
+
this.id = proposedId;
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
if (thisTag > lastTag) {
|
|
170
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
171
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
if (thisTag < lastTag) {
|
|
175
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
176
|
+
}
|
|
177
|
+
var title = $(this).attr('toc-title');
|
|
178
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
179
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
180
|
+
lastTag = thisTag;
|
|
181
|
+
});
|
|
182
|
+
if (!show) return;
|
|
183
|
+
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
|
184
|
+
$('#content').prepend(html);
|
|
185
|
+
$('#toc').append(_toc);
|
|
186
|
+
$('#toc .hide_toc').toggle(function() {
|
|
187
|
+
$('#toc .top').slideUp('fast');
|
|
188
|
+
$('#toc').toggleClass('hidden');
|
|
189
|
+
$('#toc .title small').toggle();
|
|
190
|
+
}, function() {
|
|
191
|
+
$('#toc .top').slideDown('fast');
|
|
192
|
+
$('#toc').toggleClass('hidden');
|
|
193
|
+
$('#toc .title small').toggle();
|
|
194
|
+
});
|
|
195
|
+
$('#toc .float_toc').toggle(function() {
|
|
196
|
+
$(this).text('float');
|
|
197
|
+
$('#toc').toggleClass('nofloat');
|
|
198
|
+
}, function() {
|
|
199
|
+
$(this).text('left');
|
|
200
|
+
$('#toc').toggleClass('nofloat');
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
$(framesInit);
|
|
205
|
+
$(createSourceLinks);
|
|
206
|
+
$(createDefineLinks);
|
|
207
|
+
$(createFullTreeLinks);
|
|
208
|
+
$(fixBoxInfoHeights);
|
|
209
|
+
$(searchFrameLinks);
|
|
210
|
+
$(linkSummaries);
|
|
211
|
+
$(keyboardShortcuts);
|
|
212
|
+
$(summaryToggle);
|
|
213
|
+
$(fixOutsideWorldLinks);
|
|
214
|
+
$(generateTOC);
|