Skip to main content

/

Docs

Log in

Mojo struct

TensorShape

A space efficient representation of a tensor shape. This struct implements value semantics and owns its underlying data.

Implemented traits​

AnyType, CollectionElement, Copyable, EqualityComparable, Formattable, Movable, Stringable

Methods​

__init__​

__init__(inout self: Self)

Default initializer for TensorShape.

__init__(inout self: Self, shapes: Tuple[element_types])

Initializes a TensorShape from the values provided.

Args:

  • ​shapes (Tuple[element_types]): The shapes to initialize the shape with.

__init__(inout self: Self, *shapes: Int)

Initializes a TensorShape from the values provided.

Args:

  • ​*shapes (Int): The shapes to initialize the shape with.

__init__(inout self: Self, shapes: VariadicList[Int])

Initializes a TensorShape from the values provided.

Args:

  • ​shapes (VariadicList[Int]): The shapes to initialize the shape with.

__init__(inout self: Self, shapes: List[Int, hint_trivial_type])

Initializes a TensorShape from the list provided.

Args:

  • ​shapes (List[Int, hint_trivial_type]): The list to initialize the shape with.

__init__[rank: Int](inout self: Self, shapes: StaticIntTuple[rank])

Initializes a TensorShape from the values provided.

Parameters:

  • ​rank (Int): The rank.

Args:

  • ​shapes (StaticIntTuple[rank]): The shapes to initialize the shape with.

__copyinit__​

__copyinit__(inout self: Self, other: Self)

Creates a deep copy of an existing shape.

Args:

  • ​other (Self): The shape to copy.

__moveinit__​

__moveinit__(inout self: Self, owned existing: Self)

Move initializer for the shape.

Args:

  • ​existing (Self): The shape to move.

__del__​

__del__(owned self: Self)

Delete the shape and release any owned memory.

__getitem__​

__getitem__(self: Self, index: Int) -> Int

Gets the dimension at the specified index.

Args:

  • ​index (Int): The dimension index.

Returns:

The dimension at the specified index.

__eq__​

__eq__(self: Self, other: Self) -> Bool

Returns True if the two values are the same and False otherwise.

Args:

  • ​other (Self): The other TensorShape to compare against.

Returns:

True if the two shapes are the same and False otherwise.

__ne__​

__ne__(self: Self, other: Self) -> Bool

Returns True if the two values are not the same and False otherwise.

Args:

  • ​other (Self): The other TensorShape to compare against.

Returns:

True if the two shapes are the not the same and False otherwise.

rank​

rank(self: Self) -> Int

Gets the rank of the shape.

Returns:

The rank of the shape.

num_elements​

num_elements(self: Self) -> Int

Gets the total number of elements in the shape.

Returns:

The total number of elements in the shape.

__repr__​

__repr__(self: Self) -> String

Returns the string representation of the shape.

Returns:

The string representation of the shape.

__str__​

__str__(self: Self) -> String

Returns the string representation of the shape.

Returns:

The string representation of the shape.

format_to​

format_to(self: Self, inout writer: Formatter)

Formats this TensorShape to the provided formatter.

Args:

  • ​writer (Formatter): The formatter to write to.

Was this page helpful?