Skip to content

Commit 66439c2

Browse files
committed
Update README.md
1 parent 8e07243 commit 66439c2

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ A simple script to implement linear algebra functions not provided by the Lua st
1515
Documentation
1616
---
1717

18+
### Matrix Functions
19+
#### Matrix Instantiation Functions
20+
1821
<details>
1922
<summary><code>linalg.matrix.new = function(rows)</code></summary>
2023

@@ -85,6 +88,8 @@ An n-length array whose entries will be set as the diagonal entries
8588

8689
</details>
8790

91+
#### Matrix Classification Functions
92+
8893
<details>
8994
<summary><code>linalg.matrix.isDiagonal = function(mat)</code></summary>
9095

@@ -134,6 +139,8 @@ True if the matrix is lower triangular, false otherwise
134139

135140
</details>
136141

142+
#### Basic Matrix Operation Functions
143+
137144
<details>
138145
<summary><code>linalg.matrix.transpose = function(mat)</code></summary>
139146

@@ -167,6 +174,23 @@ The matrix exponential approximation
167174

168175
</details>
169176

177+
### Vector Functions
178+
#### Vector Instantiation Functions
179+
180+
<details>
181+
<summary><code>linalg.vector.new = function(values)</code></summary>
182+
183+
Creates a new column vector
184+
185+
**Parameters:**
186+
- `values` (`array<number>`)
187+
The values to have for the column vector
188+
189+
**Returns:**
190+
[t:(n x 1) matrix] The new column vector
191+
192+
</details>
193+
170194
<details>
171195
<summary><code>linalg.vector.e = function(i, n)</code></summary>
172196

@@ -184,6 +208,8 @@ The dimensionality of the vector
184208

185209
</details>
186210

211+
#### Vector Norm Functions
212+
187213
<details>
188214
<summary><code>linalg.vector.norm.l1 = function(v)</code></summary>
189215

@@ -232,6 +258,8 @@ The resulting value
232258

233259
</details>
234260

261+
#### Vector Inner Product Functions
262+
235263
<details>
236264
<summary><code>linalg.vector.ip.dot = function(v1, v2)</code></summary>
237265

@@ -250,6 +278,8 @@ The result
250278

251279
</details>
252280

281+
#### Basic Vector Operation Functions
282+
253283
<details>
254284
<summary><code>linalg.vector.project = function (v, u, innerProductFunc, normFunc)</code></summary>
255285

@@ -304,6 +334,8 @@ The angle to rotate by (in radians)
304334

305335
</details>
306336

337+
#### Vector Space Functions
338+
307339
<details>
308340
<summary><code>linalg.gramSchmidt = function (u, epsilon, dim, innerProductFunc, normFunc)</code></summary>
309341

lib/linalg.lua

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -693,6 +693,13 @@ end
693693
-- VECTOR FUNCTIONS
694694
linalg.vector = {}
695695

696+
--[[**
697+
Creates a new column vector
698+
699+
@param [t:array<number>] values The values to have for the column vector
700+
701+
@returns [t:(n x 1) matrix] The new column vector
702+
**--]]
696703
linalg.vector.new = function(values)
697704
local rows = {}
698705

0 commit comments

Comments
 (0)