Package com.yahoo.tensor

Class TensorType.Dimension

java.lang.Object

com.yahoo.tensor.TensorType.Dimension

All Implemented Interfaces:

Comparable<TensorType.Dimension>

Direct Known Subclasses:

TensorType.IndexedBoundDimension, TensorType.IndexedUnboundDimension, TensorType.MappedDimension

Enclosing class:

TensorType

public abstract static class TensorType.Dimension
extends Object
implements Comparable<TensorType.Dimension>

A tensor dimension. Dimensions have the natural order of their names.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TensorType.Dimension.Type

Method Summary

Modifier and Type	Method	Description
int	compareTo(TensorType.Dimension other)
boolean	equals(Object other)
int	hashCode()
static TensorType.Dimension	indexed(String name)
static TensorType.Dimension	indexed(String name, long size)
boolean	isIndexed()	Returns true if this is an indexed bound or unbound type
boolean	isMapped()	Returns true if this is of the mapped type
static TensorType.Dimension	mapped(String name)
final String	name()
abstract Optional<Long>	size()	Returns the size of this dimension if it is bound, empty otherwise Beware not use == !
abstract String	toString()
abstract TensorType.Dimension.Type	type()
abstract TensorType.Dimension	withName(String name)	Returns a copy of this with the name set to the given name
TensorType.Dimension	withSize(long size)	Returns a copy of this with the size set to the given value

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

name

public final String name()

size

public abstract Optional<Long> size()

Returns the size of this dimension if it is bound, empty otherwise Beware not use == != when comparing size. Use equals

type

public abstract TensorType.Dimension.Type type()

withName

public abstract TensorType.Dimension withName(String name)

Returns a copy of this with the name set to the given name

withSize

public TensorType.Dimension withSize(long size)

Returns a copy of this with the size set to the given value

isIndexed

public boolean isIndexed()

Returns true if this is an indexed bound or unbound type

isMapped

public boolean isMapped()

Returns true if this is of the mapped type

toString

public abstract String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(TensorType.Dimension other)

Specified by:

compareTo in interface Comparable<TensorType.Dimension>

indexed

public static TensorType.Dimension indexed(String name,
 long size)

indexed

public static TensorType.Dimension indexed(String name)

mapped

public static TensorType.Dimension mapped(String name)