Module dfdx::shapes

Shape related traits/structes like Shape, Dtype, Dim, Axis, and Const

Example shapes:

let _: Rank3<2, 3, 4> = Default::default();
let _: (Const<2>, Const<3>) = Default::default();
let _: (usize, Const<4>) = (3, Const);
let _ = (Const::<5>, 4, Const::<3>, 2);

Structs

• Axes2
  A set of 2 axes, e.g. Axes2<0, 1>, or Axes2<1, 3>.
• Axes3
  A set of 3 axes, e.g. Axes3<1, 3, 4>
• Axes4
  A set of 4 axes
• Axes5
  A set of 5 axes
• Axes6
  A set of 6 axes
• Axis
  A singular axis, e.g. Axis<0> or Axis<1>
• Const
  Represents a Dim with size known at compile time

Traits

• Array
  Represents either [T; N] or Vec<T>
• ConstDim
  Represents a single dimension where all instances are guaranteed to be the same size at compile time.
• ConstShape
  Represents a Shape that has all ConstDims
• Dim
  Represents a single dimension of a multi dimensional Shape
• Dtype
  Represents a data type or element of an array.
• HasAxes
  Represents something that has the axes Ax
• HasDtype
  Represents something that has a Dtype.
• HasShape
  Represents something that has a Shape.
• HasUnitType
  Represents something that has a Unit.
• Shape
  A collection of dimensions (Dim) that change how a multi-dimensional array is interacted with.
• Unit
  Represents a unit type, but no arithmetic.

Type Definitions

• Rank0
  Compile time known shape with 0 dimensions
• Rank1
  Compile time known shape with 1 dimensions
• Rank2
  Compile time known shape with 2 dimensions
• Rank3
  Compile time known shape with 3 dimensions
• Rank4
  Compile time known shape with 4 dimensions
• Rank5
  Compile time known shape with 5 dimensions
• Rank6
  Compile time known shape with 6 dimensions