sleipnir.autodiff.VariableMatrix Class Reference

Public Member Functions
None	__init__ (self)
None	__init__ (self, int rows)
None	__init__ (self, int rows, int cols)
None	__init__ (self, Sequence[Sequence[Variable]] list)
None	__init__ (self, Sequence[Sequence[float]] list)
None	__init__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] values)
None	__init__ (self, Annotated[NDArray[numpy.float32], dict(shape=(None, None))] values)
None	__init__ (self, Variable variable)
None	__init__ (self, VariableBlock values)
None	__init__ (self, VariableBlock arg)
None	set_value (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] values)
None	set_value (self, Annotated[NDArray[numpy.float32], dict(shape=(None, None))] values)
None	set_value (self, Annotated[NDArray[numpy.int64], dict(shape=(None, None))] values)
None	set_value (self, Annotated[NDArray[numpy.int32], dict(shape=(None, None))] values)
Variable	__setitem__ (self, int row, Variable value)
None	__setitem__ (self, tuple slices, object value)
Variable	__getitem__ (self, int row)
object	__getitem__ (self, tuple slices)
VariableBlock	row (self, int row)
VariableBlock	col (self, int col)
VariableMatrix	__mul__ (self, VariableMatrix rhs)
VariableMatrix	__mul__ (self, VariableBlock rhs)
VariableMatrix	__mul__ (self, VariableBlock rhs)
VariableMatrix	__mul__ (self, float rhs)
VariableMatrix	__mul__ (self, int rhs)
VariableMatrix	__mul__ (self, Variable rhs)
VariableMatrix	__rmul__ (self, VariableBlock lhs)
VariableMatrix	__rmul__ (self, float lhs)
VariableMatrix	__rmul__ (self, int lhs)
VariableMatrix	__rmul__ (self, Variable lhs)
VariableMatrix	__matmul__ (self, VariableMatrix rhs)
VariableMatrix	__matmul__ (self, VariableBlock rhs)
VariableMatrix	__matmul__ (self, VariableMatrix rhs)
VariableMatrix	__matmul__ (self, VariableBlock rhs)
object	__array_ufunc__ (self, object ufunc, str method, *inputs, **kwargs)
VariableMatrix	__add__ (self, VariableMatrix rhs)
Variable	__add__ (self, float rhs)
Variable	__add__ (self, int rhs)
Variable	__add__ (self, Variable rhs)
VariableMatrix	__add__ (self, VariableBlock rhs)
VariableMatrix	__add__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)
VariableMatrix	__sub__ (self, VariableMatrix rhs)
Variable	__sub__ (self, float rhs)
Variable	__sub__ (self, int rhs)
Variable	__sub__ (self, Variable rhs)
VariableMatrix	__sub__ (self, VariableBlock rhs)
VariableMatrix	__sub__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)
VariableMatrix	__neg__ (self)
VariableMatrix	__truediv__ (self, float rhs)
VariableMatrix	__truediv__ (self, int rhs)
VariableMatrix	__truediv__ (self, Variable rhs)
VariableMatrix	__itruediv__ (self, float rhs)
VariableMatrix	__itruediv__ (self, int rhs)
VariableMatrix	__itruediv__ (self, Variable rhs)
Variable	__radd__ (self, float lhs)
Variable	__radd__ (self, int lhs)
Variable	__radd__ (self, Variable lhs)
VariableMatrix	__radd__ (self, VariableBlock lhs)
VariableMatrix	__radd__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] lhs)
Variable	__rsub__ (self, float lhs)
Variable	__rsub__ (self, int lhs)
Variable	__rsub__ (self, Variable lhs)
VariableMatrix	__rsub__ (self, VariableBlock lhs)
VariableMatrix	__rsub__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] lhs)
VariableMatrix	__pow__ (self, int power)
VariableMatrix	T (self)
int	rows (self)
int	cols (self)
tuple	shape (self)
float	value (self, int row, int col)
float	value (self, int index)
Annotated[NDArray[numpy.float64], dict(shape=(None, None), order='F')]	value (self)
VariableMatrix	cwise_map (self, Callable[[Variable], Variable] func)
VariableMatrix	exp (self)
EqualityConstraints	__eq__ (self, VariableMatrix rhs)
EqualityConstraints	__eq__ (self, float rhs)
EqualityConstraints	__eq__ (self, float rhs)
EqualityConstraints	__eq__ (self, int rhs)
EqualityConstraints	__eq__ (self, int rhs)
EqualityConstraints	__eq__ (self, Variable rhs)
EqualityConstraints	__eq__ (self, Variable rhs)
EqualityConstraints	__eq__ (self, VariableBlock rhs)
EqualityConstraints	__eq__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)
InequalityConstraints	__lt__ (self, VariableMatrix rhs)
InequalityConstraints	__lt__ (self, float rhs)
InequalityConstraints	__lt__ (self, float rhs)
InequalityConstraints	__lt__ (self, int rhs)
InequalityConstraints	__lt__ (self, int rhs)
InequalityConstraints	__lt__ (self, Variable rhs)
InequalityConstraints	__lt__ (self, Variable rhs)
InequalityConstraints	__lt__ (self, VariableBlock rhs)
InequalityConstraints	__lt__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)
InequalityConstraints	__le__ (self, VariableMatrix rhs)
InequalityConstraints	__le__ (self, float rhs)
InequalityConstraints	__le__ (self, float rhs)
InequalityConstraints	__le__ (self, int rhs)
InequalityConstraints	__le__ (self, int rhs)
InequalityConstraints	__le__ (self, Variable rhs)
InequalityConstraints	__le__ (self, Variable rhs)
InequalityConstraints	__le__ (self, VariableBlock rhs)
InequalityConstraints	__le__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)
InequalityConstraints	__gt__ (self, VariableMatrix rhs)
InequalityConstraints	__gt__ (self, float rhs)
InequalityConstraints	__gt__ (self, float rhs)
InequalityConstraints	__gt__ (self, int rhs)
InequalityConstraints	__gt__ (self, int rhs)
InequalityConstraints	__gt__ (self, Variable rhs)
InequalityConstraints	__gt__ (self, Variable rhs)
InequalityConstraints	__gt__ (self, VariableBlock rhs)
InequalityConstraints	__gt__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)
InequalityConstraints	__ge__ (self, VariableMatrix rhs)
InequalityConstraints	__ge__ (self, float rhs)
InequalityConstraints	__ge__ (self, float rhs)
InequalityConstraints	__ge__ (self, int rhs)
InequalityConstraints	__ge__ (self, int rhs)
InequalityConstraints	__ge__ (self, Variable rhs)
InequalityConstraints	__ge__ (self, Variable rhs)
InequalityConstraints	__ge__ (self, VariableBlock rhs)
InequalityConstraints	__ge__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)
int	__len__ (self)
Iterator[Variable]	__iter__ (self)

Static Public Member Functions
VariableMatrix	identity (int rows)
VariableMatrix	zero (int rows, int cols)
VariableMatrix	one (int rows, int cols)
VariableMatrix	constant (int rows, int cols, float constant)

Constructor & Destructor Documentation

__init__() [1/10]

None sleipnir.autodiff.VariableMatrix.__init__

(

self

)

Constructs an empty VariableMatrix.

__init__() [2/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		int	rows
	)

Constructs a zero-initialized VariableMatrix column vector with the
given rows.

Args:
    rows: The number of matrix rows.

__init__() [3/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		int	rows,
		int	cols
	)

Constructs a zero-initialized VariableMatrix with the given
dimensions.

Args:
    rows: The number of matrix rows.
    cols: The number of matrix columns.

__init__() [4/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		Sequence[Sequence[Variable]]	list
	)

Constructs a scalar VariableMatrix from a nested list of Variables.

Args:
    list: The nested list of Variables.

__init__() [5/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		Sequence[Sequence[float]]	list
	)

Constructs a scalar VariableMatrix from a nested list of scalars.

This overload is for Python bindings only.

Args:
    list: The nested list of Variables.

__init__() [6/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	values
	)

__init__() [7/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		Annotated[NDArray[numpy.float32], dict(shape=(None, None))]	values
	)

Constructs a VariableMatrix from an Eigen matrix.

Args:
    values: Eigen matrix of values.

__init__() [8/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		Variable	variable
	)

Constructs a scalar VariableMatrix from a Variable.

Args:
    variable: Variable.

__init__() [9/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		VariableBlock	values
	)

Constructs a VariableMatrix from a VariableBlock.

Args:
    values: VariableBlock of values.

__init__() [10/10]

None sleipnir.autodiff.VariableMatrix.__init__	(		self,
		VariableBlock	arg
	)

Member Function Documentation

__add__() [1/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__add__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

__add__() [2/6]

Variable sleipnir.autodiff.VariableMatrix.__add__	(		self,
		float	rhs
	)

__add__() [3/6]

Variable sleipnir.autodiff.VariableMatrix.__add__	(		self,
		int	rhs
	)

__add__() [4/6]

Variable sleipnir.autodiff.VariableMatrix.__add__	(		self,
		Variable	rhs
	)

__add__() [5/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__add__	(		self,
		VariableBlock	rhs
	)

__add__() [6/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__add__	(		self,
		VariableMatrix	rhs
	)

__array_ufunc__()

object sleipnir.autodiff.VariableMatrix.__array_ufunc__	(		self,
		object	ufunc,
		str	method,
		*	inputs,
		**	kwargs
	)

__eq__() [1/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Equality operator that returns an equality constraint for two
Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__eq__() [2/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		float	rhs
	)

__eq__() [3/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		float	rhs
	)

__eq__() [4/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		int	rhs
	)

__eq__() [5/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		int	rhs
	)

__eq__() [6/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		Variable	rhs
	)

__eq__() [7/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		Variable	rhs
	)

__eq__() [8/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		VariableBlock	rhs
	)

__eq__() [9/9]

EqualityConstraints sleipnir.autodiff.VariableMatrix.__eq__	(		self,
		VariableMatrix	rhs
	)

__ge__() [1/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__ge__() [2/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		float	rhs
	)

__ge__() [3/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		float	rhs
	)

__ge__() [4/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		int	rhs
	)

__ge__() [5/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		int	rhs
	)

__ge__() [6/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		Variable	rhs
	)

__ge__() [7/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		Variable	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__ge__() [8/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		VariableBlock	rhs
	)

__ge__() [9/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__ge__	(		self,
		VariableMatrix	rhs
	)

__getitem__() [1/2]

Variable sleipnir.autodiff.VariableMatrix.__getitem__	(		self,
		int	row
	)

Returns the element at the given index.

Args:
    index: The index.

Returns:
    The element at the given index.

__getitem__() [2/2]

object sleipnir.autodiff.VariableMatrix.__getitem__	(		self,
		tuple	slices
	)

Returns the element at the given row and column.

Args:
    row: The row.
    col: The column.

Returns:
    The element at the given row and column.

__gt__() [1/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__gt__() [2/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		float	rhs
	)

__gt__() [3/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		float	rhs
	)

__gt__() [4/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		int	rhs
	)

__gt__() [5/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		int	rhs
	)

__gt__() [6/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		Variable	rhs
	)

__gt__() [7/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		Variable	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__gt__() [8/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		VariableBlock	rhs
	)

__gt__() [9/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__gt__	(		self,
		VariableMatrix	rhs
	)

__iter__()

Iterator[Variable] sleipnir.autodiff.VariableMatrix.__iter__

(

self

)

__itruediv__() [1/3]

VariableMatrix sleipnir.autodiff.VariableMatrix.__itruediv__	(		self,
		float	rhs
	)

__itruediv__() [2/3]

VariableMatrix sleipnir.autodiff.VariableMatrix.__itruediv__	(		self,
		int	rhs
	)

__itruediv__() [3/3]

VariableMatrix sleipnir.autodiff.VariableMatrix.__itruediv__	(		self,
		Variable	rhs
	)

Compound matrix division-assignment operator.

Args:
    rhs: Variable to divide.

Returns:
    Result of division.

__le__() [1/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__le__() [2/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		float	rhs
	)

__le__() [3/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		float	rhs
	)

__le__() [4/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		int	rhs
	)

__le__() [5/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		int	rhs
	)

__le__() [6/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		Variable	rhs
	)

__le__() [7/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		Variable	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__le__() [8/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		VariableBlock	rhs
	)

__le__() [9/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__le__	(		self,
		VariableMatrix	rhs
	)

__len__()

int sleipnir.autodiff.VariableMatrix.__len__

(

self

)

Returns the number of rows in the matrix.

Returns:
    The number of rows in the matrix.

__lt__() [1/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__lt__() [2/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		float	rhs
	)

__lt__() [3/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		float	rhs
	)

__lt__() [4/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		int	rhs
	)

__lt__() [5/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		int	rhs
	)

__lt__() [6/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		Variable	rhs
	)

__lt__() [7/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		Variable	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Args:
    lhs: Left-hand side.
    rhs: Left-hand side.

__lt__() [8/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		VariableBlock	rhs
	)

__lt__() [9/9]

InequalityConstraints sleipnir.autodiff.VariableMatrix.__lt__	(		self,
		VariableMatrix	rhs
	)

__matmul__() [1/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__matmul__	(		self,
		VariableBlock	rhs
	)

__matmul__() [2/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__matmul__	(		self,
		VariableBlock	rhs
	)

__matmul__() [3/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__matmul__	(		self,
		VariableMatrix	rhs
	)

__matmul__() [4/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__matmul__	(		self,
		VariableMatrix	rhs
	)

__mul__() [1/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__mul__	(		self,
		float	rhs
	)

__mul__() [2/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__mul__	(		self,
		int	rhs
	)

__mul__() [3/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__mul__	(		self,
		Variable	rhs
	)

__mul__() [4/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__mul__	(		self,
		VariableBlock	rhs
	)

__mul__() [5/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__mul__	(		self,
		VariableBlock	rhs
	)

__mul__() [6/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__mul__	(		self,
		VariableMatrix	rhs
	)

__neg__()

VariableMatrix sleipnir.autodiff.VariableMatrix.__neg__

(

self

)

__pow__()

VariableMatrix sleipnir.autodiff.VariableMatrix.__pow__	(		self,
		int	power
	)

__radd__() [1/5]

VariableMatrix sleipnir.autodiff.VariableMatrix.__radd__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	lhs
	)

__radd__() [2/5]

Variable sleipnir.autodiff.VariableMatrix.__radd__	(		self,
		float	lhs
	)

__radd__() [3/5]

Variable sleipnir.autodiff.VariableMatrix.__radd__	(		self,
		int	lhs
	)

__radd__() [4/5]

Variable sleipnir.autodiff.VariableMatrix.__radd__	(		self,
		Variable	lhs
	)

__radd__() [5/5]

VariableMatrix sleipnir.autodiff.VariableMatrix.__radd__	(		self,
		VariableBlock	lhs
	)

__rmul__() [1/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__rmul__	(		self,
		float	lhs
	)

__rmul__() [2/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__rmul__	(		self,
		int	lhs
	)

__rmul__() [3/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__rmul__	(		self,
		Variable	lhs
	)

__rmul__() [4/4]

VariableMatrix sleipnir.autodiff.VariableMatrix.__rmul__	(		self,
		VariableBlock	lhs
	)

__rsub__() [1/5]

VariableMatrix sleipnir.autodiff.VariableMatrix.__rsub__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	lhs
	)

__rsub__() [2/5]

Variable sleipnir.autodiff.VariableMatrix.__rsub__	(		self,
		float	lhs
	)

__rsub__() [3/5]

Variable sleipnir.autodiff.VariableMatrix.__rsub__	(		self,
		int	lhs
	)

__rsub__() [4/5]

Variable sleipnir.autodiff.VariableMatrix.__rsub__	(		self,
		Variable	lhs
	)

__rsub__() [5/5]

VariableMatrix sleipnir.autodiff.VariableMatrix.__rsub__	(		self,
		VariableBlock	lhs
	)

__setitem__() [1/2]

Variable sleipnir.autodiff.VariableMatrix.__setitem__	(		self,
		int	row,
		Variable	value
	)

__setitem__() [2/2]

None sleipnir.autodiff.VariableMatrix.__setitem__	(		self,
		tuple	slices,
		object	value
	)

__sub__() [1/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__sub__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

__sub__() [2/6]

Variable sleipnir.autodiff.VariableMatrix.__sub__	(		self,
		float	rhs
	)

__sub__() [3/6]

Variable sleipnir.autodiff.VariableMatrix.__sub__	(		self,
		int	rhs
	)

__sub__() [4/6]

Variable sleipnir.autodiff.VariableMatrix.__sub__	(		self,
		Variable	rhs
	)

__sub__() [5/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__sub__	(		self,
		VariableBlock	rhs
	)

__sub__() [6/6]

VariableMatrix sleipnir.autodiff.VariableMatrix.__sub__	(		self,
		VariableMatrix	rhs
	)

__truediv__() [1/3]

VariableMatrix sleipnir.autodiff.VariableMatrix.__truediv__	(		self,
		float	rhs
	)

__truediv__() [2/3]

VariableMatrix sleipnir.autodiff.VariableMatrix.__truediv__	(		self,
		int	rhs
	)

__truediv__() [3/3]

VariableMatrix sleipnir.autodiff.VariableMatrix.__truediv__	(		self,
		Variable	rhs
	)

col()

VariableBlock sleipnir.autodiff.VariableMatrix.col	(		self,
		int	col
	)

Returns a column slice of the variable matrix.

Args:
    col: The column to slice.

Returns:
    A column slice of the variable matrix.

cols()

int sleipnir.autodiff.VariableMatrix.cols

(

self

)

Returns the number of columns in the matrix.

Returns:
    The number of columns in the matrix.

constant()

VariableMatrix sleipnir.autodiff.VariableMatrix.constant ( int  rows, int  cols, float  constant  )

static

Returns a variable matrix filled with a constant.

Args:
    rows: The number of matrix rows.
    cols: The number of matrix columns.
    constant: The constant.

Returns:
    A variable matrix filled with a constant.

cwise_map()

VariableMatrix sleipnir.autodiff.VariableMatrix.cwise_map	(		self,
		Callable[[Variable], Variable]	func
	)

Transforms the matrix coefficient-wise with an unary operator.

Args:
    unary_op: The unary operator to use for the transform operation.

Returns:
    Result of the unary operator.

exp()

VariableMatrix sleipnir.autodiff.VariableMatrix.exp

(

self

)

Returns the matrix exponential.

Returns:
    The matrix exponential.

identity()

VariableMatrix sleipnir.autodiff.VariableMatrix.identity ( int  rows )

static

Returns an identity variable matrix.

Args:
    rows: The number of matrix rows.

Returns:
    An identity variable matrix.

one()

VariableMatrix sleipnir.autodiff.VariableMatrix.one ( int  rows, int  cols  )

static

Returns a variable matrix filled with ones.

Args:
    rows: The number of matrix rows.
    cols: The number of matrix columns.

Returns:
    A variable matrix filled with ones.

row()

VariableBlock sleipnir.autodiff.VariableMatrix.row	(		self,
		int	row
	)

Returns a row slice of the variable matrix.

Args:
    row: The row to slice.

Returns:
    A row slice of the variable matrix.

rows()

int sleipnir.autodiff.VariableMatrix.rows

(

self

)

Returns the number of rows in the matrix.

Returns:
    The number of rows in the matrix.

set_value() [1/4]

None sleipnir.autodiff.VariableMatrix.set_value	(		self,
		Annotated[NDArray[numpy.float32], dict(shape=(None, None))]	values
	)

set_value() [2/4]

None sleipnir.autodiff.VariableMatrix.set_value	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	values
	)

set_value() [3/4]

None sleipnir.autodiff.VariableMatrix.set_value	(		self,
		Annotated[NDArray[numpy.int32], dict(shape=(None, None))]	values
	)

Sets the VariableMatrix's internal values.

Args:
    values: Eigen matrix of values.

set_value() [4/4]

None sleipnir.autodiff.VariableMatrix.set_value	(		self,
		Annotated[NDArray[numpy.int64], dict(shape=(None, None))]	values
	)

shape()

tuple sleipnir.autodiff.VariableMatrix.shape

(

self

)

T()

VariableMatrix sleipnir.autodiff.VariableMatrix.T

(

self

)

Returns the transpose of the variable matrix.

Returns:
    The transpose of the variable matrix.

value() [1/3]

Annotated[NDArray[numpy.float64], dict(shape=(None, None), order='F')] sleipnir.autodiff.VariableMatrix.value

(

self

)

Returns the contents of the variable matrix.

Returns:
    The contents of the variable matrix.

value() [2/3]

float sleipnir.autodiff.VariableMatrix.value	(		self,
		int	index
	)

Returns an element of the variable matrix.

Args:
    index: The index of the element to return.

Returns:
    An element of the variable matrix.

value() [3/3]

float sleipnir.autodiff.VariableMatrix.value	(		self,
		int	row,
		int	col
	)

Returns an element of the variable matrix.

Args:
    row: The row of the element to return.
    col: The column of the element to return.

Returns:
    An element of the variable matrix.

zero()

VariableMatrix sleipnir.autodiff.VariableMatrix.zero ( int  rows, int  cols  )

static

Returns a variable matrix filled with zeros.

Args:
    rows: The number of matrix rows.
    cols: The number of matrix columns.

Returns:
    A variable matrix filled with zeros.

---

The documentation for this class was generated from the following file:

• /home/runner/work/Sleipnir/Sleipnir/python/src/sleipnir/autodiff/__init__.py