rc.base.definitions

Type and constant definitions.

All modules of RomCom import * from this module, so all types and constants in this module are referenced without adornment throughout RomCom.

Properties

zero	Tolerance when testing floats for equality.

Classes

Pd	Extended Pandas types and constants.
Np	Extended NumPy types and constants. This class should never be instantiated or subclassed.
Tc	Extended PyTorch types and constants. This class should never be instantiated or subclassed.

Module Contents

zero: float = 1e-64

Tolerance when testing floats for equality.

class Pd

Extended Pandas types and constants.

DataFrame

pd.DataFrame.

Index

pd.Index.

MultiIndex

pd.MultiIndex.

class Np

Extended NumPy types and constants. This class should never be instantiated or subclassed.

DType

np.dtype.

Array

np.ndarray.

Tensor

Array.

Vector

Column vector, first order Tensor .shape = (i,1).

CoVector = Tensor

Row vector, first order Tensor .shape = (1,j).

Matrix = Tensor

Second order Tensor .shape = (i,j).

class Tc

Extended PyTorch types and constants. This class should never be instantiated or subclassed.

DType

tc.dtype.

Tensor

tc.Tensor.

Vector

Column vector, first order Tensor .shape = (i,1).

CoVector = Tensor

Row vector, first order Tensor .shape = (1,j).

Matrix = Tensor

Second order Tensor .shape = (i,j).

BatchVector = Tensor

Vector .shape = (...,i,1).

BatchCoVector = Tensor

CoVector .shape = (...,1,j).

BatchMatrix = Tensor

Matrix .shape = (...,i,j).