matrix

package

v0.1.0 Latest Latest Go to latest Published: Dec 5, 2022 License: MIT Imports: 4 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Dimension struct {
	Width  int
	Height int
}

type Matrix[T constraints.Integer | constraints.Float] struct {
	Dimensions Dimension
	Values     [][]T
}

func New[T constraints.Integer | constraints.Float](err *error, values ...[]T) Matrix[T]

New instantiates a Matrix with the passed values.

func NewIdentity[T constraints.Integer | constraints.Float](err *error, dim Dimension) Matrix[T]

NewIdentity instantiates an identity matrix of the specified dimensions.

func NewZero[T constraints.Integer | constraints.Float](err *error, dim Dimension) Matrix[T]

NewZero instantiates a zero matrix of the specified dimensions.

func (a Matrix[T]) Add(err *error, b Matrix[T]) Matrix[T]

Add a matrix to another one. The dimensions of the matrices must match.

func (a Matrix[T]) ApproxEqual(b Matrix[T], errorMargin T) bool

func (a Matrix[T]) Clone() Matrix[T]

func (a Matrix[T]) Equal(b Matrix[T]) bool

func (a Matrix[T]) Inverse(err *error) Matrix[T]

Inverse a matrix TODO: figure out how to handle integers properly.

func (a Matrix[T]) Multiply(err *error, b Matrix[T]) Matrix[T]

Multiply multiplies the matrix by another matrix. The height of matix B must match the width of matrix A.

func (a Matrix[T]) MultiplyScalar(err *error, x T) Matrix[T]

MultiplyScalar multiplies the Matrix by a scalar.

func (a Matrix[T]) String() string

func (a Matrix[T]) Subtract(err *error, b Matrix[T]) Matrix[T]

Subtract a matrix from another one. The dimensions of the matrices must match.

func (a Matrix[T]) Transpose(err *error) Matrix[T]

Transpose calculates the transpose of a Matrix.