minieigen documentation

miniEigen is wrapper for a small part of the Eigen library. Refer to its documentation for details. All classes in this module support pickling.

class minieigen.AlignedBox2

Axis-aligned box object in 2d, defined by its minimum and maximum corners

area() → float
center() → Vector2
clamp((AlignedBox2)arg2) → None
contains((Vector2)arg2) → bool

contains( (AlignedBox2)arg1, (AlignedBox2)arg2) → bool

empty() → bool
extend((Vector2)arg2) → None

extend( (AlignedBox2)arg1, (AlignedBox2)arg2) → None

intersection((AlignedBox2)arg2) → AlignedBox2
max
merged((AlignedBox2)arg2) → AlignedBox2
min
sizes() → Vector2
volume() → float
class minieigen.AlignedBox3

Axis-aligned box object, defined by its minimum and maximum corners

center() → Vector3
clamp((AlignedBox3)arg2) → None
contains((Vector3)arg2) → bool

contains( (AlignedBox3)arg1, (AlignedBox3)arg2) → bool

empty() → bool
extend((Vector3)arg2) → None

extend( (AlignedBox3)arg1, (AlignedBox3)arg2) → None

intersection((AlignedBox3)arg2) → AlignedBox3
max
merged((AlignedBox3)arg2) → AlignedBox3
min
sizes() → Vector3
volume() → float
class minieigen.Matrix3

3x3 float matrix.

Supported operations (m is a Matrix3, f if a float/int, v is a Vector3): -m, m+m, m+=m, m-m, m-=m, m*f, f*m, m*=f, m/f, m/=f, m*m, m*=m, m*v, v*m, m==m, m!=m.

Static attributes: Zero, Ones, Identity.

Identity = Matrix3(1,0,0, 0,1,0, 0,0,1)
Ones = Matrix3(1,1,1, 1,1,1, 1,1,1)
Random() → Matrix3 [STATIC]
Zero = Matrix3(0,0,0, 0,0,0, 0,0,0)
col((int)arg2) → Vector3
determinant() → float
diagonal() → Vector3
inverse() → Matrix3
maxAbsCoeff() → float
norm() → float
pruned([(float)absTol=1e-06]) → Matrix3
row((int)arg2) → Vector3
sum() → float
trace() → float
transpose() → Matrix3
class minieigen.Matrix6

6x6 float matrix. Constructed from 4 3x3 sub-matrices, from 6xVector6 (rows).

Supported operations (m is a Matrix6, f if a float/int, v is a Vector6): -m, m+m, m+=m, m-m, m-=m, m*f, f*m, m*=f, m/f, m/=f, m*m, m*=m, m*v, v*m, m==m, m!=m.

Static attributes: Zero, Ones, Identity.

Identity = Matrix6( ( 1, 0, 0, 0, 0, 0), ( 0, 1, 0, 0, 0, 0), ( 0, 0, 1, 0, 0, 0), ( 0, 0, 0, 1, 0, 0), ( 0, 0, 0, 0, 1, 0), ( 0, 0, 0, 0, 0, 1), )
Ones = Matrix6( ( 1, 1, 1, 1, 1, 1), ( 1, 1, 1, 1, 1, 1), ( 1, 1, 1, 1, 1, 1), ( 1, 1, 1, 1, 1, 1), ( 1, 1, 1, 1, 1, 1), ( 1, 1, 1, 1, 1, 1), )
Random() → Matrix6 [STATIC]
Zero = Matrix6( ( 0, 0, 0, 0, 0, 0), ( 0, 0, 0, 0, 0, 0), ( 0, 0, 0, 0, 0, 0), ( 0, 0, 0, 0, 0, 0), ( 0, 0, 0, 0, 0, 0), ( 0, 0, 0, 0, 0, 0), )
col((int)arg2) → Vector6
determinant() → float
diagonal() → Vector6
inverse() → Matrix6
ll() → Matrix3
lr() → Matrix3
row((int)arg2) → Vector6
sum() → float
trace() → float
transpose() → Matrix6
ul() → Matrix3
ur() → Matrix3
class minieigen.MatrixX

XxX (dynamic-sized) float matrix. Constructed from list of rows (as VectorX).

Supported operations (m is a MatrixX, f if a float/int, v is a VectorX): -m, m+m, m+=m, m-m, m-=m, m*f, f*m, m*=f, m/f, m/=f, m*m, m*=m, m*v, v*m, m==m, m!=m.

Random((int)arg2) → MatrixX [STATIC]
col((int)arg2) → VectorX
cols() → int
determinant() → float
diagonal() → VectorX
inverse() → MatrixX
maxAbsCoeff() → float
pruned([(float)absTol=1e-06]) → MatrixX
resize((int)arg2, (int)arg3) → None
row((int)arg2) → VectorX
rows() → int
sum() → float
trace() → float
transpose() → MatrixX
class minieigen.Quaternion

Quaternion representing rotation.

Supported operations (q is a Quaternion, v is a Vector3): q*q (rotation composition), q*=q, q*v (rotating v by q), q==q, q!=q.

Static attributes: Identity.

Identity = Quaternion((1,0,0),0)
Rotate((Vector3)v) → Vector3
conjugate() → Quaternion
inverse() → Quaternion
norm() → float
normalize() → None
normalized() → Quaternion
setFromTwoVectors((Vector3)u, (Vector3)v) → Quaternion
toAngleAxis() → tuple
toAxisAngle() → tuple
toRotationMatrix() → Matrix3
toRotationVector() → Vector3
class minieigen.Vector2

3-dimensional float vector.

Supported operations (f if a float/int, v is a Vector3): -v, v+v, v+=v, v-v, v-=v, v*f, f*v, v*=f, v/f, v/=f, v==v, v!=v.

Implicit conversion from sequence (list, tuple, ...) of 2 floats.

Static attributes: Zero, Ones, UnitX, UnitY.

Ones = Vector2(1,1)
Random() → Vector2 [STATIC]
Unit() → Vector2 [STATIC]
UnitX = Vector2(1,0)
UnitY = Vector2(0,1)
Zero = Vector2(0,0)
dot((Vector2)arg2) → float
norm() → float
normalize() → None
normalized() → Vector2
squaredNorm() → float
sum() → float
class minieigen.Vector2i

2-dimensional integer vector.

Supported operations (i if an int, v is a Vector2i): -v, v+v, v+=v, v-v, v-=v, v*i, i*v, v*=i, v==v, v!=v.

Implicit conversion from sequence (list, tuple, ...) of 2 integers.

Static attributes: Zero, Ones, UnitX, UnitY.

Ones = Vector2i(1,1)
Unit() → Vector2i [STATIC]
UnitX = Vector2i(1,0)
UnitY = Vector2i(0,1)
Zero = Vector2i(0,0)
dot((Vector2i)arg2) → float
sum() → int
class minieigen.Vector3

3-dimensional float vector.

Supported operations (f if a float/int, v is a Vector3): -v, v+v, v+=v, v-v, v-=v, v*f, f*v, v*=f, v/f, v/=f, v==v, v!=v, plus operations with Matrix3 and Quaternion.

Implicit conversion from sequence (list, tuple, ...) of 3 floats.

Static attributes: Zero, Ones, UnitX, UnitY, UnitZ.

Ones = Vector3(1,1,1)
Random() → Vector3 [STATIC]
Unit() → Vector3 [STATIC]
UnitX = Vector3(1,0,0)
UnitY = Vector3(0,1,0)
UnitZ = Vector3(0,0,1)
Zero = Vector3(0,0,0)
asDiagonal() → Matrix3
cross((Vector3)arg2) → Vector3
dot((Vector3)arg2) → float
maxAbsCoeff() → float
norm() → float
normalize() → None
normalized() → Vector3
outer((Vector3)arg2) → Matrix3
pruned([(float)absTol=1e-06]) → Vector3
squaredNorm() → float
sum() → float
xy() → Vector2
xz() → Vector2
yx() → Vector2
yz() → Vector2
zx() → Vector2
zy() → Vector2
class minieigen.Vector3i

3-dimensional integer vector.

Supported operations (i if an int, v is a Vector3i): -v, v+v, v+=v, v-v, v-=v, v*i, i*v, v*=i, v==v, v!=v.

Implicit conversion from sequence (list, tuple, ...) of 3 integers.

Static attributes: Zero, Ones, UnitX, UnitY, UnitZ.

Ones = Vector3i(1,1,1)
Unit() → Vector3i [STATIC]
UnitX = Vector3i(1,0,0)
UnitY = Vector3i(0,1,0)
UnitZ = Vector3i(0,0,1)
Zero = Vector3i(0,0,0)
cross((Vector3i)arg2) → Vector3i
dot((Vector3i)arg2) → float
sum() → int
class minieigen.Vector6

6-dimensional float vector.

Supported operations (f if a float/int, v is a Vector6): -v, v+v, v+=v, v-v, v-=v, v*f, f*v, v*=f, v/f, v/=f, v==v, v!=v.

Implicit conversion from sequence (list, tuple, ...) of 6 floats.

Static attributes: Zero, Ones.

Ones = Vector6(1,1,1, 1,1,1)
Random() → Vector6 [STATIC]
Zero = Vector6(0,0,0, 0,0,0)
asDiagonal() → Matrix6
head() → Vector3
norm() → float
normalize() → None
normalized() → Vector6
squaredNorm() → float
sum() → float
tail() → Vector3
class minieigen.Vector6i

6-dimensional float vector.

Supported operations (f if a float/int, v is a Vector6): -v, v+v, v+=v, v-v, v-=v, v*f, f*v, v*=f, v/f, v/=f, v==v, v!=v.

Implicit conversion from sequence (list, tuple, ...) of 6 floats.

Static attributes: Zero, Ones.

Ones = Vector6i(1,1,1, 1,1,1)
Zero = Vector6i(0,0,0, 0,0,0)
head() → Vector3i
sum() → int
tail() → Vector3i
class minieigen.VectorX

Dynamic-sized float vector.

Supported operations (f if a float/int, v is a VectorX): -v, v+v, v+=v, v-v, v-=v, v*f, f*v, v*=f, v/f, v/=f, v==v, v!=v.

Implicit conversion from sequence (list, tuple, ...) of X floats.

Random() → VectorX [STATIC]
asDiagonal() → MatrixX
norm() → float
normalize() → None
normalized() → VectorX
resize((int)arg2) → None
size() → int
squaredNorm() → float
sum() → float