k3math
A toy math implementation with Vector, Matrix, and Polynomial classes for basic linear algebra operations.
k3math is a component of pykit3 project: a python3 toolkit set.
Installation
pip install k3math
Quick Start
from k3math import Vector, Matrix, Polynomial
# Vector operations
v1 = Vector([1, 2, 3])
v2 = Vector([4, 5, 6])
print(v1 + v2) # [5.0, 7.0, 9.0]
print(v1 * 2) # [2.0, 4.0, 6.0]
print(v1.inner_product(v2)) # 32.0
# Matrix operations
m = Matrix([
[1, 2],
[3, 4]
])
print(m.determinant()) # -2.0
print(m.solve([5, 11])) # [1.0, 2.0] (solves x + 2y = 5, 3x + 4y = 11)
# Polynomial curve fitting
xs = [1, 2, 3, 4, 5]
ys = [2.1, 4.0, 5.9, 8.1, 10.0]
poly = Polynomial.fit(xs, ys, degree=1)
print(poly) # Displays the fitted polynomial
API Reference
k3math
Matrix
Bases: list
Source code in k3math/mth.py
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 118 119 120 121 122 123 124 | |
determinant()
Calculate determinant of this matrix. E.g.::
| a b | = a*d - b*c
| c d |
Returns:
| Type | Description |
|---|---|
|
float |
Source code in k3math/mth.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | |
minor(i, j)
Make a new matrix without i-th row and j-th column.
Source code in k3math/mth.py
44 45 46 47 48 49 50 51 52 53 | |
solve(ys)
Solve equations::
|a00 a01 a02| |x0| |y0|
|a10 a11 a12| * |x1| = |y1|
|a20 a21 a22| |x2| |y2|
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
y
|
Vector
|
a vector of |
required |
Returns:
| Type | Description |
|---|---|
|
Vector |
Source code in k3math/mth.py
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 | |
Polynomial
Bases: list
It represents a polynomial: y = a₀ + a₁ * x¹ + a₂ * x² ...
Where coefficients = [a₀, a₁, a₂ .. ].
xs and ys is array of x-coordinate value and y-coordinate value. They are all real numbers.
xs = [1, 2, 3, 4, 5..] ys = [1, 2, 4, 7, 11..]
With xs and ys to calc the coefficients of a polinomial
degree is the highest power of polinomial: degree=2: y = a0 + a1x + a2x^2
Source code in k3math/mth.py
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 | |
fit(clz, xs, ys, degree)
classmethod
Find a polynomial curve with least squares method.
Args:
x(Vector): Vector of x positions
y(Vector): Vector of y positions
degree(int): the highest power of variable `x` in the polynomial.
Returns:
| Type | Description |
|---|---|
|
Polynomial |
Source code in k3math/mth.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | |
get_fitting_equation(clz, xs, ys, degree)
classmethod
Curve fit with least squres
We looking for a curve:
Y = a0 + a1*x + a2*x^2
that minimize variance:
E = sum((Y[i]-ys[i])^2)
Partial derivatives about a0..an are:
E'a0 = sum(2 * (a0 + a1*xs[i] + a2*xs[i]^2 - ys[i]) * 1)
E'a1 = sum(2 * (a0 + a1*xs[i] + a2*xs[i]^2 - ys[i]) * xs[i])
E'a2 = sum(2 * (a0 + a1*xs[i] + a2*xs[i]^2 - ys[i]) * xs[i]^2)
The best fit is a curve that minimizes E: or all partial derivatives are 0:
| c00 c01 c02 | | a0 | | Y0 |
| c10 c11 c12 | * | a1 | = | Y1 |
| c20 c21 c22 | | a2 | | Y2 |
c00 = 2 * n
c01 = 2 * sum(xs[i])
c02 = 2 * sum(xs[i]^2)
Y0 = 2 * sum(ys[i])
c10 = 2 * sum(xs[i])
c11 = 2 * sum(xs[i]^2)
c12 = 2 * sum(xs[i]^3)
Y1 = 2 * sum(ys[i]*xs[i])
...
Source code in k3math/mth.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | |
interpolation(clz, xs, ys, degree, x)
classmethod
guess value at x with polynomial regression
Source code in k3math/mth.py
290 291 292 293 294 295 296 297 298 299 | |
plot(clz, polynomials, rangex, rangey=None, width=120, height=20, points=())
classmethod
Plot a polynomial with text::
poly = [3.5, 3.4, 1]
for l in Polynomial.plot([(poly, '.')],
rangex=[-1, 6],
width=40, height=10):
print l
# .
# ..
# ..
# ..
# ...
# ...
# ...
# ....
# ....
# .....
# ...........
Args:
polynomials: list of a vector of polynomial coefficients and symbol::
[ ([1, 6], 'x'), # y = 1 + 6x, plot with "x"
([2, 2, 2], '.'), # y = 2 + 2x + 2x^2, plot with "."
]
rangex(float): is a tuple of two floats that specifies range of x.
rangey(float): is a tuple of two floats that specifies range of y.
width(int): specifies plot graph width.
height(int): specifies plot graph height.
points: other points to add to the plot.
It is a vector of ``(x, y[, char])``.
``char`` is optional to specify point mark.
By default it is ``X``.
Returns:
| Type | Description |
|---|---|
|
list of strings |
Source code in k3math/mth.py
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 | |
Vector
Bases: list
A Vector is a list supporting operations:
+: vector adds vector-: vector subtracts vector*: vector times scalar**: vector powers scalar
Source code in k3math/mth.py
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 | |
inner_product(b)
Calculate inner product of two vector and returns a new Vector.
Source code in k3math/mth.py
32 33 34 35 36 | |
License
The MIT License (MIT) - Copyright (c) 2015 Zhang Yanpo (张炎泼)