Dimension class
(Shortest import: from brian2.units.fundamentalunits import Dimension)
- class brian2.units.fundamentalunits.Dimension(dims)[source]
Bases:
object
Stores the indices of the 7 basic SI unit dimension (length, mass, etc.).
Provides a subset of arithmetic operations appropriate to dimensions: multiplication, division and powers, and equality testing.
- Parameters:
dims : sequence of
float
The dimension indices of the 7 basic SI unit dimensions.
Notes
Users shouldn’t use this class directly, it is used internally in Quantity and Unit. Even internally, never use
Dimension(...)
to create a new instance, useget_or_create_dimension()
instead. This function makes sure that only one Dimension instance exists for every combination of indices, allowing for a very fast dimensionality check withis
.Attributes
Returns the
Dimension
object itself.Whether this Dimension is dimensionless.
Methods
Return a specific dimension.
Details
- dim
Returns the
Dimension
object itself. This can be useful, because it allows to check for the dimension of an object by checking itsdim
attribute – this will return aDimension
object forQuantity
,Unit
andDimension
.
- is_dimensionless
Whether this Dimension is dimensionless.
Notes
Normally, instead one should check dimension for being identical to
DIMENSIONLESS
.