Template Class Shape#
Defined in File sizetype.hpp
Class Documentation#
-
template<typename T = size_t, size_t N = 32>
class Shape# -
Public Functions
-
Shape() = default#
Default constructor.
-
template<typename Scalar, size_t... Dimensions>
explicit Shape(const FixedStorage<Scalar, Dimensions...> &fixed)# Create a shape object from the dimensions of a FixedStorage object. This is used.
- Template Parameters
Scalar – Scalar type of the FixedStorage object
Dimensions – Dimensions of the FixedStorage object
- Parameters
fixed – The FixedStorage object
-
template<typename V, typename typetraits::EnableIf<typetraits::CanCast<V, T>::value> = 0>
Shape(const std::initializer_list<V> &vals)# Create a Shape object from a list of values
- Template Parameters
V – Scalar type of the values
- Parameters
vals – The dimensions for the object
-
template<typename V, typename typetraits::EnableIf<typetraits::CanCast<V, T>::value> = 0>
explicit Shape(const std::vector<V> &vals)# Create a Shape object from a vector of values
- Template Parameters
V – Scalar type of the values
- Parameters
vals – The dimensions for the object
-
Shape(const Shape &other) = default#
Create a copy of a Shape object
- Parameters
other – Shape object to copy
-
Shape(Shape &&other) noexcept = default#
Create a Shape from an RValue
- Parameters
other – Temporary Shape object to copy
-
template<typename V, size_t Dim>
Shape(const Shape<V, Dim> &other)# Create a Shape object from one with a different type and number of dimensions.
- Template Parameters
V – Scalar type of the values
Dim – Number of dimensions
- Parameters
other – Shape object to copy
-
template<typename V, size_t Dim>
Shape(Shape<V, Dim> &&other) noexcept# Create a Shape object from one with a different type and number of dimensions, moving it instead of copying it.
- Template Parameters
V – Scalar type of the values
Dim – Number of dimensions
- Parameters
other – Temporary Shape object to move
-
template<typename V, typename typetraits::EnableIf<typetraits::CanCast<V, T>::value> = 0>
Shape &operator=(const std::initializer_list<V> &vals)# Assign a Shape object to this object
-
template<typename V, typename typetraits::EnableIf<typetraits::CanCast<V, T>::value> = 0>
Shape &operator=(const std::vector<V> &vals)# Assign a Shape object to this object
-
Shape &operator=(Shape &&other) noexcept = default#
Assign an RValue Shape to this object
- Parameters
other – RValue to move
- Returns
-
Shape &operator=(const Shape &other) = default#
Assign a Shape to this object
- Parameters
other – Shape to copy
- Returns
-
template<typename Index>
const T &operator[](Index index) const# Access an element of the Shape object
- Template Parameters
Index – Typename of the index
- Parameters
index – Index to access
- Returns
The value at the index
-
template<typename Index>
T &operator[](Index index)# Access an element of the Shape object
- Template Parameters
Index – Typename of the index
- Parameters
index – Index to access
- Returns
A reference to the value at the index
-
bool operator==(const Shape &other) const#
Compare two Shape objects, returning true if and only if they are identical
- Parameters
other – Shape object to compare
- Returns
true if the objects are identical
-
bool operator!=(const Shape &other) const#
Compare two Shape objects, returning true if and only if they are not identical
- Parameters
other – Shape object to compare
- Returns
true if the objects are not identical
-
Shape subshape(size_t start, size_t end) const#
Return a subshape of the Shape object
- Parameters
start – Starting index
end – Ending index
- Returns
Subshape
-
T size() const#
Return the number of elements the Shape object represents
- Returns
Number of elements
-
std::string str(const std::string &format = "{}") const#
Convert a Shape object into a string representation
- Returns
A string representation of the Shape object
-
Shape() = default#