UNPKG

dataframe-js

Version:

Immutable and functional data structure for datascientists and developpers

gmousse.gitbooks.io/dataframe-js/

Gmousse/dataframe-js

117 lines (65 loc) • 2.77 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<!-- Generated by documentation.js. Update this documentation by updating the source code. --> ### Table of Contents - [Matrix][1] - [isCommutative][2] - [add][3] - [product][4] - [dot][5] ## Matrix [src/modules/matrix.js:8-103][6] Matrix module for DataFrame, providing basic mathematical matrix computations. **Parameters** - `df` **DataFrame** An instance of DataFrame. ### isCommutative [src/modules/matrix.js:26-34][7] Check if two DataFrames are commutative, if both have the same dimensions. **Parameters** - `df` **DataFrame** The second DataFrame to check. - `reverse` **[Boolean][8]** Revert the second DataFrame before the comparison. (optional, default `false`) **Examples** ```javascript df.matrix.isCommutative(df2) ``` Returns **[Boolean][8]** True if they are commutative, else false. ### add [src/modules/matrix.js:43-58][9] Provide an elements pairwise addition of two DataFrames having the same dimensions. **Parameters** - `df` **DataFrame** The second DataFrame to add. **Examples** ```javascript df.matrix.add(df2) ``` Returns **DataFrame** A new DataFrame resulting to the addition two DataFrames. ### product [src/modules/matrix.js:67-71][10] Provide a scalar product between a number and a DataFrame. **Parameters** - `number` **[Number][11]** The number to multiply. **Examples** ```javascript df.matrix.product(6) ``` Returns **DataFrame** A new DataFrame resulting to the scalar product. ### dot [src/modules/matrix.js:80-102][12] Multiply one DataFrame n x p and a second p x n. **Parameters** - `df` **DataFrame** The second DataFrame to multiply. **Examples** ```javascript df.matrix.dot(df) ``` Returns **DataFrame** A new n x n DataFrame resulting to the product of two DataFrame. [1]: #matrix [2]: #iscommutative [3]: #add [4]: #product [5]: #dot [6]: https://github.com/Gmousse/dataframe-js/blob/cef738e8a8e82e94515dfc49f015f842a8c410f2/src/modules/matrix.js#L8-L103 "Source code on GitHub" [7]: https://github.com/Gmousse/dataframe-js/blob/cef738e8a8e82e94515dfc49f015f842a8c410f2/src/modules/matrix.js#L26-L34 "Source code on GitHub" [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean [9]: https://github.com/Gmousse/dataframe-js/blob/cef738e8a8e82e94515dfc49f015f842a8c410f2/src/modules/matrix.js#L43-L58 "Source code on GitHub" [10]: https://github.com/Gmousse/dataframe-js/blob/cef738e8a8e82e94515dfc49f015f842a8c410f2/src/modules/matrix.js#L67-L71 "Source code on GitHub" [11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number [12]: https://github.com/Gmousse/dataframe-js/blob/cef738e8a8e82e94515dfc49f015f842a8c410f2/src/modules/matrix.js#L80-L102 "Source code on GitHub"