Overview
C++ API (1199)
class Dims : public VINT64 { explicit Dims(INT64 d1 = DIM_ABSENT, INT64 d2 = DIM_ABSENT, INT64 d3 = DIM_ABSENT, INT64 d4 = DIM_ABSENT); Dims(const VINT64& stl); Dims(const Dimensions& dims); Dims& operator=(const VINT64& stl); Dims& operator=(const Dimensions& dims); Dimensions cdims() const; operator string() const; UINT64 getNumberOfElements() const; };

Provides an object that can hold a vector representing a list of dimensions, used by various interface aspects in the bindings. It can be converted to and from a Dimensions structure, for interaction with the C Component Interface.

A particular use is inline construction of a representation of dimensions, such that the syntax function(Dims(1, 3), ...), for instance, is valid.

Interface

explicit Dims(INT64 d1 = DIM_ABSENT, INT64 d2 = DIM_ABSENT, INT64 d3 = DIM_ABSENT, INT64 d4 = DIM_ABSENT)
Construct with the specified content.
explicit Dims(const VINT64& stl)
Construct with content taken from the passed STL vector.
operator string() const
Convert to a human-readable string of the form "d1, d2, ... dN".
UINT64 getNumberOfElements() const
Return the product of unity and all the entries in the dimensions object.