Shape

The size of an unknown axis or the total unknown size for an unknown Shape.

Returns a new Shape, with a new last dimension added. In order for this call to succeed, isUnknown() must be false.

Returns a new Shape, with another Shapes' dimensions appended. For both this Shape and the other Shape, isUnknown() must return false. E.g. @code Shape.of(3,4).append(Shape.of(1,2)) => Shape.of(3,4,1,2) }

Returns a defensive copy of the this Shape's axes. Changes to the returned array to not change this Shape's state. Returns null if isUnknown() is true.

Equals implementation for Shapes. Two Shapes are considered equal iff:

• the number of dimensions is defined and equal for both
• the size of each dimension is defined and equal for both

If either Shape has unknown dimensions (even if they are the same in both) or if either shape has an unknown number of dimensions (even if both return true for isUnknown()), they are not considered equal! However, a shape will always equal itself, even if it is unknown or contains unknown dimensions.

Returns whether one or more dimensions of this Shape have an unknown size.

Returns a 1-dimensional Shape with first dimension matching the first dimension of this Shape.

Test to see if two shape dimensions are compatible.

The dimensions are compatible if either dimension is Shape.UNKNOWN_SIZE or both dimensions are equal

Determines whether another shape is compatible with this one.

Two possibly-partially-defined shapes are compatible if there exists a fully-defined shape that both shapes can represent. Thus, compatibility allows the shape inference code to reason about partially-defined shapes. For example:

• Shape.unknown() is compatible with all shapes.
• Shape(UNKNOWN_SIZE, UNKNOWN_SIZE) is compatible with all two-dimensional shapes, such as Shape(32, 784), and also Shape.unknown(). It is not compatible with, for example, Shape(UNKNOWN_SIZE) or Shape(UNKNOWN_SIZE, UNKNOWN_SIZE, UNKNOWN_SIZE).
• Shape(32, UNKNOWN_SIZE) is compatible with all two-dimensional shapes with size 32 in the 0th dimension, and also Shape(UNKNOWN_SIZE, UNKNOWN_SIZE) and Shape.unknown(). It is not compatible with, for example, Shape(32) , Shape(32, UNKNOWN_SIZE, 1) or Shape(64, UNKNOWN_SIZE).
• Shape(32, 784) is compatible with itself, and also Shape(32, UNKNOWN_SIZE), Shape(UNKNOWN_SIZE, 784), Shape(UNKNOWN_SIZE, UNKNOWN_SIZE) and Shape.unknown(). It is not compatible with, for example, Shape(32, 1, 784) or Shape(UNKNOWN_SIZE) .

The compatibility relation is reflexive and symmetric, but not transitive. For example, Shape(32, 784) is compatible with Shape.unknown(), and Shape.unknown() is compatible with Shape(4, 4), but Shape(32, 784) is not compatible with Shape(4, 4).

Compatibility is not the same as broadcasting. Compatible shapes must have the same number of dimensions and for each dimension pair, one dimension has to equal the other dimensions or at least one of the dimensions in the pair has to be UNKNOWN_SIZE.

Broadcasting allows different dimensions, but paired dimensions have to either be equal, or one dimension must be 1. If one shape has less dimensions than another shape, the smaller shape is "stretched" with dimensions of 1.

Returns whether this Shape is the shape of a matrix

Returns whether this Shape represents a scalar.

Returns whether the number of dimensions of this Shape is unknown.

Returns whether this Shape is the shape of a vector.

Returns the number of dimensions of this Shape. -1 if unknown, 0 for a scalar, 1 for a vector, 2 for a matrix etc.

Create a Shape representing a scalar or an N-dimensional value.

Creates a Shape representing a scalar or an N-dimensional value (N being at least 1), with the provided size for each dimension. A -1 indicates that the size of the corresponding dimension is unknown. If no sizes are provided, a Shape representing a scalar is created. For example:

// A 2-element vector.
 Shape vector = Shape.of(2);

 // A 2x3 matrix.
 Shape matrix = Shape.of(2, 3);

 // A matrix with 4 columns but an unknown number of rows.
 // This is typically used to indicate the shape of tensors that represent
 // a variable-sized batch of values. The Shape below might represent a
 // variable-sized batch of 4-element vectors.
 Shape batch = Shape.of(-1, 4);

 // A scalar. For readability, you should prefer calling Shape.scalar()
 Shape scalar = Shape.of()
 

Returns a new Shape, with another Shape's dimensions prepended. For both this Shape and the other Shape, isUnknown() must return false. E.g. Shape.of(3,4).prepend(Shape.of(1,2)) => Shape.of(1,2,3,4)

Returns a new Shape, with a new first dimension added. In order for this call to succeed, isUnknown() must be false.

Creates a Shape representing a scalar value.

The size of the dimension with the given index.

If isUnknown() is true or the size of the dimension with the given index has an unknown size, UNKNOWN_SIZE is returned.

Returns the total number of elements a Tensor with this Shape would have.

If isUnknown() is true or hasUnknownDimension() is true, UNKNOWN_SIZE is returned.

Return a end - begin dimensional shape with dimensions matching this Shape from begin to end.

Returns a new Shape, with this Shape's first dimension removed.

Returns an n-dimensional Shape with the dimensions matching the first n dimensions of this shape

Returns an n-dimensional Shape with the dimensions matching the last n dimensions of this Shape.

Succinct description of the Shape meant for debugging.

Creates a Shape representing an unknown number of dimensions.