smErrors

Documentation

Index

• func CheckDimensionsInAddition(left, right MatrixLike) error
• func CheckDimensionsInComparison(arg1, arg2 MatrixLike, comparisonType string) error
• func CheckDimensionsInHStack(sliceToStack ...MatrixLike) error
• func CheckDimensionsInMultiplication(left, right MatrixLike) error
• func CheckDimensionsInSubtraction(left, right MatrixLike) error
• func CheckDimensionsInVStack(sliceToStack ...MatrixLike) error
• func CheckIndexOnMatrix(rowIndex int, colIndex int, matrix MatrixLike) error
• func CheckIndexOnVector(index int, vector MatrixLike) error
• func IsScalarExpression(e MatrixLike) bool
• type CanNotGetLinearCoeffOfConstantError
  • func (lce CanNotGetLinearCoeffOfConstantError) Error() string
• type EmptyLinearCoeffsError
  • func (elce EmptyLinearCoeffsError) Error() string
• type EmptyMatrixError
  • func (eme EmptyMatrixError) Error() string
• type EmptyVectorError
  • func (eve EmptyVectorError) Error() string
• type EqualityConstraintRequiredError
  • func (e EqualityConstraintRequiredError) Error() string
• type InequalityConstraintRequiredError
  • func (icre InequalityConstraintRequiredError) Error() string
• type InvalidMatrixIndexError
  • func (imi InvalidMatrixIndexError) Error() string
• type InvalidVectorIndexError
  • func (ivi InvalidVectorIndexError) Error() string
• type LinearExpressionRequiredError
  • func (lere LinearExpressionRequiredError) Error() string
• type MatrixColumnMismatchError
  • func (mcme MatrixColumnMismatchError) Error() string
• type MatrixDimensionError
  • func (de MatrixDimensionError) ArgDimsAsStrings() []string
  • func (de MatrixDimensionError) Error() string
• type MatrixLike
• type NegativeExponentError
  • func (e NegativeExponentError) Error() string
• type UnsupportedInputError
  • func (uie UnsupportedInputError) Error() string
• type VectorDimensionError
  • func (de VectorDimensionError) Error() string
• type VectorLike

Functions

func CheckDimensionsInAddition

func CheckDimensionsInAddition(left, right MatrixLike) error

func CheckDimensionsInComparison

func CheckDimensionsInComparison(arg1, arg2 MatrixLike, comparisonType string) error

func CheckDimensionsInHStack

func CheckDimensionsInHStack(sliceToStack ...MatrixLike) error

CheckDimensionsInHStack Description:

This function checks that the dimensions of the left and right expressions
are compatible for horizontal stacking.
We allow:
- Stacking if the number of rows match

func CheckDimensionsInMultiplication

func CheckDimensionsInMultiplication(left, right MatrixLike) error

CheckDimensionsInMultiplication Description:

This function checks that the dimensions of the left and right expressions
are compatible for multiplication.
We allow:
- Multiplication if Dimensions Match OR
- Multiplication if one of the expressions is a scalar

func CheckDimensionsInSubtraction

func CheckDimensionsInSubtraction(left, right MatrixLike) error

CheckDimensionsInSubtraction Description:

This function checks that the dimensions of the left and right expressions

func CheckDimensionsInVStack

func CheckDimensionsInVStack(sliceToStack ...MatrixLike) error

CheckDimensionsInVStack Description:

This function checks that the dimensions of the left and right expressions
are compatible for vertical stacking.
We allow:
- Stacking if the number of columns match

func CheckIndexOnMatrix

func CheckIndexOnMatrix(rowIndex int, colIndex int, matrix MatrixLike) error

CheckIndexOnMatrix Description:

Checks that the index is valid for the matrix.

func CheckIndexOnVector

func CheckIndexOnVector(index int, vector MatrixLike) error

Explicit Functions

func IsScalarExpression

func IsScalarExpression(e MatrixLike) bool

IsScalarExpression Description:

Determines whether or not an input object is a valid "ScalarExpression" according to Dims().

Types

type CanNotGetLinearCoeffOfConstantError

type CanNotGetLinearCoeffOfConstantError struct {
	Expression interface{}
}

func (CanNotGetLinearCoeffOfConstantError) Error

func (lce CanNotGetLinearCoeffOfConstantError) Error() string

type EmptyLinearCoeffsError

type EmptyLinearCoeffsError struct {
	Expression interface{}
}

Type

func (EmptyLinearCoeffsError) Error

func (elce EmptyLinearCoeffsError) Error() string

Error Function

type EmptyMatrixError

type EmptyMatrixError struct {
	Expression MatrixLike
}

Type

func (EmptyMatrixError) Error

func (eme EmptyMatrixError) Error() string

Error Function

type EmptyVectorError

type EmptyVectorError struct {
	Expression MatrixLike
}

Type

func (EmptyVectorError) Error

func (eve EmptyVectorError) Error() string

Error Function

type EqualityConstraintRequiredError

type EqualityConstraintRequiredError struct {
	Operation string
}

func (EqualityConstraintRequiredError) Error

func (e EqualityConstraintRequiredError) Error() string

type InequalityConstraintRequiredError

type InequalityConstraintRequiredError struct {
	Operation string
}

func (InequalityConstraintRequiredError) Error

func (icre InequalityConstraintRequiredError) Error() string

type InvalidMatrixIndexError

type InvalidMatrixIndexError struct {
	RowIndex   int
	ColIndex   int
	Expression MatrixLike
}

func (InvalidMatrixIndexError) Error

func (imi InvalidMatrixIndexError) Error() string

type InvalidVectorIndexError

type InvalidVectorIndexError struct {
	Index      int
	Expression MatrixLike
}

func (InvalidVectorIndexError) Error

func (ivi InvalidVectorIndexError) Error() string

type LinearExpressionRequiredError

type LinearExpressionRequiredError struct {
	Operation  string
	Expression interface{}
}

func (LinearExpressionRequiredError) Error

func (lere LinearExpressionRequiredError) Error() string

type MatrixColumnMismatchError

type MatrixColumnMismatchError struct {
	ExpectedNColumns int
	ActualNColumns   int
	Row              int
}

func (MatrixColumnMismatchError) Error

func (mcme MatrixColumnMismatchError) Error() string

type MatrixDimensionError

type MatrixDimensionError struct {
	Arg1      MatrixLike
	Arg2      MatrixLike
	Operation string // Either multiply or Plus
}

MatrixDimensionError Description:

This error is thrown when two matrices do not have the appropriate dimensions
for a given operation.

func (MatrixDimensionError) ArgDimsAsStrings

func (de MatrixDimensionError) ArgDimsAsStrings() []string

func (MatrixDimensionError) Error

func (de MatrixDimensionError) Error() string

type MatrixLike

type MatrixLike interface {
	Dims() []int
}

type NegativeExponentError

type NegativeExponentError struct {
	Exponent int
}

Type Definition

func (NegativeExponentError) Error

func (e NegativeExponentError) Error() string

Error

type UnsupportedInputError

type UnsupportedInputError struct {
	FunctionName string
	Input        interface{}
}

Error Definition

func (UnsupportedInputError) Error

func (uie UnsupportedInputError) Error() string

type VectorDimensionError

type VectorDimensionError struct {
	Arg1      VectorLike
	Arg2      VectorLike
	Operation string
}

VectorDimensionError Description:

This error is thrown when two matrices do not have the appropriate dimensions
for a given operation.

func (VectorDimensionError) Error

func (de VectorDimensionError) Error() string

type VectorLike

type VectorLike interface {
	Len() int
	Dims() []int
}

VectorLike Description:

An interface for all objects that can be treated as vectors.