zmath.matrix

Defines a squared Matrix with column-major ordering from 2x2 to 4x4 size

  • Mat2f

    Declaration

    alias Mat2f = Matrix!(float, 2LU).Matrix;

    2D squared matrix of floats

  • Mat3f

    Declaration

    alias Mat3f = Matrix!(float, 3LU).Matrix;

    3D squared matrix of floats

  • Mat4f

    Declaration

    alias Mat4f = Matrix!(float, 4LU).Matrix;

    4D squared matrix of floats

  • Mat2d

    Declaration

    alias Mat2d = Matrix!(double, 2LU).Matrix;

    2D squared matrix of doubles

  • Mat3d

    Declaration

    alias Mat3d = Matrix!(double, 3LU).Matrix;

    3D squared matrix of doubles

  • Mat4d

    Declaration

    alias Mat4d = Matrix!(double, 4LU).Matrix;

    4D squared matrix of doubles

  • Mat2r

    Declaration

    alias Mat2r = Matrix!(real, 2LU).Matrix;

    2D squared matrix of reals

  • Mat3r

    Declaration

    alias Mat3r = Matrix!(real, 3LU).Matrix;

    3D squared matrix of reals

  • Mat4r

    Declaration

    alias Mat4r = Matrix!(real, 4LU).Matrix;

    4D squared matrix of reals

  • Matrix

    Declaration

    struct Matrix(T, size_t dim_) if (__traits(isFloating, T) && (dim_ >= 2) && (dim_ <= 4));

    Defines a squared Matrix of n = 2, 3 or 4 size, like a linear array of numbers in a row-major order

    • dim

      Declaration

      static enum size_t dim;

      Matrix Dimension

    • cells

      Declaration

      static enum size_t cells;

      Matrix number of cells

    • ZERO

      Declaration

      static enum Matrix!(T, 2) ZERO;

      Zero R2 matrix

    • IDENTITY

      Declaration

      static enum Matrix!(T, 2) IDENTITY;

      Identity R2 matrix

    • opIndex

      Declaration

      const pure @nogc T opIndex(size_t row, size_t col);

      Returns i, j cell

    • opIndexAssign

      Declaration

      @nogc void opIndexAssign(K)(K val, size_t row, size_t col) if (is(K : real));

      Assigns a new cell value

    • opIndex

      Declaration

      const pure @nogc VRow opIndex(size_t i);

      Returns i row vector

    • opIndexAssign

      Declaration

      @nogc void opIndexAssign(K)(K v, size_t i) if (isVector!K);

      Assigns a new row vector

    • opEquals

      Declaration

      const pure @nogc bool opEquals()(auto ref const Matrix rhs);

      Define Equality

    • approxEqual

      Declaration

      const pure @nogc bool approxEqual()(auto ref const Matrix rhs, T maxRelDiff = 0.01, T maxAbsDiff = 1e-05);

      Approximated equality

    • opUnary

      Declaration

      const pure @nogc Matrix opUnary(string op)() if (op == "+" || op == "-");

      Define unary operators + and -

    • opBinary

      Declaration

      const pure @nogc Matrix opBinary(string op)(auto ref const Matrix rhs) if ((op == "+" || op == "-") && (dim >= 2) && (dim <= 4));

      Define binary operator + and -

    • opBinary

      Declaration

      const pure @nogc Matrix opBinary(string op)(in real rhs) if (op == "*" || op == "/");

      Define Scalar multiplication

    • opBinaryRight

      Declaration

      const pure @nogc Matrix opBinaryRight(string op)(in real rhs) if (op == "*" || op == "/");

      Define Scalar multiplication

    • opBinary

      Declaration

      const pure @nogc Matrix opBinary(string op)(auto ref const Matrix rhs) if (op == "*");

      Define Matrix Product

    • opBinary

      Declaration

      const pure @nogc VCol opBinary(string op)(auto ref const VRow rhs) if (op == "*");

      Define Matrix x Vector

    • opBinaryRight

      Declaration

      const pure @nogc VCol opBinaryRight(string op)(auto ref const VCol lhs) if (op == "*");

      Define Vector x Matrix

    • transpose

      Declaration

      const pure @nogc Matrix transpose();

      Returns transposed matrix

      Discussion

      It can be used to "convert" Matrix to a row ordered matrix

    • determinant

      Declaration

      const pure @nogc T determinant();

      Returns Determinant of this matrix

    • inverse

      Declaration

      const pure @nogc Matrix inverse();

      Calcs this matrix inverse

      Return Value

      A matrix full of NaNs if this matrix isn't inverible (!isOk =1)

    • isOk

      Declaration

      const pure @nogc bool isOk();

      Checks that the matrix not have a weird NaN value

    • isFinite

      Declaration

      const pure @nogc bool isFinite();

      Checks that the matrix have finite values

    • ptr

      Declaration

      pure nothrow @nogc @property T* ptr();

      Return a pointer of the internal array

    • opCast

      Declaration

      const pure @nogc Tout opCast(Tout)() if (isMatrix!Tout && (Tout.dim >= dim));

      Casting operation that allow convert between Matrix types

    • toString

      Declaration

      const string toString();

      Returns a visual representation of this matrix

  • isMatrix

    Declaration

    immutable bool isMatrix(T);

    Say if a thing it's a Matrix