Class AnyTensor<N extends Comparable<N>>

java.lang.Object

org.ojalgo.tensor.ArrayBasedTensor<N, AnyTensor<N>>

org.ojalgo.tensor.AnyTensor<N>

All Implemented Interfaces:

Consumer<AccessAnyD<?>>, Group, Group.Additive<AnyTensor<N>>, NormedVectorSpace<AnyTensor<N>, N>, Operation, Operation.Addition<AnyTensor<N>>, ScalarOperation, ScalarOperation.Multiplication<AnyTensor<N>, N>, VectorSpace<AnyTensor<N>, N>, Access1D<N>, AccessAnyD<N>, Mutate1D, Mutate1D.Fillable<N>, MutateAnyD, MutateAnyD.Fillable<N>, MutateAnyD.Receiver<N>, Structure1D, StructureAnyD, Tensor<N, AnyTensor<N>>

public final class AnyTensor<N extends Comparable<N>>
extends ArrayBasedTensor<N, AnyTensor<N>>
implements AccessAnyD<N>, MutateAnyD.Receiver<N>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	AnyTensor.Factory<N extends Comparable<N>>

Nested classes/interfaces inherited from interface AccessAnyD

AccessAnyD.Aggregatable<N>, AccessAnyD.Collectable<N,R>, AccessAnyD.ElementView<N>, AccessAnyD.MatrixView<N>, AccessAnyD.SelectionView<N>, AccessAnyD.Sliceable<N>, AccessAnyD.VectorView<N>, AccessAnyD.Visitable<N>

Nested classes/interfaces inherited from interface Group

Group.Additive<T>, Group.Multiplicative<T>

Nested classes/interfaces inherited from interface Mutate1D

Mutate1D.Fillable<N>, Mutate1D.Mixable<N>, Mutate1D.Modifiable<N>, Mutate1D.ModifiableReceiver<N>, Mutate1D.Receiver<N>, Mutate1D.Sortable

Nested classes/interfaces inherited from interface MutateAnyD

MutateAnyD.Fillable<N>, MutateAnyD.Mixable<N>, MutateAnyD.Modifiable<N>, MutateAnyD.ModifiableReceiver<N>, MutateAnyD.Receiver<N>

Nested classes/interfaces inherited from interface Operation

Operation.Addition<T>, Operation.Division<T>, Operation.Multiplication<T>, Operation.Subtraction<T>

Nested classes/interfaces inherited from interface ScalarOperation

ScalarOperation.Addition<T,N>, ScalarOperation.Division<T,N>, ScalarOperation.Multiplication<T,N>, ScalarOperation.Subtraction<T,N>

Nested classes/interfaces inherited from interface Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S,B>, Structure1D.LongIndex, Structure1D.LoopCallback

Nested classes/interfaces inherited from interface StructureAnyD

StructureAnyD.IntReference, StructureAnyD.Logical<S,B>, StructureAnyD.LongReference, StructureAnyD.ReducibleTo1D<R>, StructureAnyD.ReducibleTo2D<R>, StructureAnyD.ReferenceCallback, StructureAnyD.ReferenceMapper, StructureAnyD.Reshapable

Field Summary

Fields

Modifier and Type	Field	Description
private final ArrayAnyD<N>	myArray
private final ArrayAnyD.Factory<N>	myFactory

Constructor Summary

Constructors

Constructor	Description
AnyTensor(ArrayAnyD.Factory<N> factory, int rank, int dimensions)

Method Summary

Modifier and Type	Method	Description
AnyTensor<N>	add(AnyTensor<N> addend)
byte	byteValue(long... ref)
AnyTensor<N>	conjugate()	This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...
long	count(int dimension)	count() == count(0) * count(1) * count(2) * count(3) * ...
double	doubleValue(int index)
double	doubleValue(long... ref)
boolean	equals(Object obj)
static <N extends Comparable<N>> TensorFactoryAnyD<N, AnyTensor<N>>	factory(DenseArray.Factory<N,?> arrayFactory)
void	fillSet(int dimension, long dimensionalIndex, N value)
void	fillSet(int dimension, long dimensionalIndex, NullaryFunction<?> supplier)
void	fillSet(long[] initial, int dimension, N value)
void	fillSet(long[] initial, int dimension, NullaryFunction<?> supplier)
float	floatValue(long... ref)
N	get(long index)
N	get(long... ref)
(package private) ArrayAnyD<N>	getArray()
int	hashCode()
int	intValue(long... ref)
long	longValue(long... ref)
AnyTensor<N>	multiply(double scalarMultiplicand)
AnyTensor<N>	multiply(N scalarMultiplicand)
AnyTensor<N>	negate()	The additive inverse of this.
(package private) AnyTensor<N>	newSameShape()
double	norm()	this == this.signum().multiply(this.norm())
void	set(int index, double value)
void	set(long[] reference, byte value)
void	set(long[] reference, double value)
void	set(long[] reference, float value)
void	set(long[] reference, int value)
void	set(long[] reference, long value)
void	set(long[] reference, short value)
void	set(long[] reference, Comparable<?> value)
void	set(long index, Comparable<?> value)
long[]	shape()
short	shortValue(long... ref)
int	size()	The total number of elements in this structure.
int	size(int dimension)
String	toString()

Methods inherited from class ArrayBasedTensor

add, dimensions, multiply, multiply, negate, norm, rank, signum

Methods inherited from class Object

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

Methods inherited from interface Access1D

asCollectable1D, asKeyed1D, asList, axpy, byteValue, byteValue, dot, doubleValue, floatValue, floatValue, intValue, intValue, longValue, longValue, nonzeros, select, shortValue, shortValue, supplyTo, toList, toRawCopy1D

Methods inherited from interface AccessAnyD

asCollectableAnyD, byteValue, doubleValue, elements, floatValue, get, intValue, longValue, matrices, select, shortValue, vectors

Methods inherited from interface Consumer

andThen

Methods inherited from interface Mutate1D

reset, set, set, set, set, set, set, set, set, set, set, set

Methods inherited from interface Mutate1D.Fillable

fillAll, fillAll, fillCompatible, fillMatching, fillMatching, fillMatching, fillMatching, fillRange, fillRange

Methods inherited from interface MutateAnyD

set, set, set, set, set, set, set

Methods inherited from interface MutateAnyD.Fillable

fillCompatible

Methods inherited from interface MutateAnyD.Receiver

accept, isAcceptable

Methods inherited from interface NormedVectorSpace

isSmall

Methods inherited from interface ScalarOperation.Multiplication

multiply

Methods inherited from interface Structure1D

count

Methods inherited from interface StructureAnyD

loop, loop, loopAllReferences, loopReferences, rank

Methods inherited from interface Tensor

components, isSameShape

Field Details

myArray

private final ArrayAnyD<N extends Comparable<N>> myArray

myFactory

private final ArrayAnyD.Factory<N extends Comparable<N>> myFactory

Constructor Details

AnyTensor

AnyTensor(ArrayAnyD.Factory<N> factory,
 int rank,
 int dimensions)

Method Details

factory

public static <N extends Comparable<N>>
TensorFactoryAnyD<N, AnyTensor<N>> factory(DenseArray.Factory<N,?> arrayFactory)

add

public AnyTensor<N> add(AnyTensor<N> addend)

Specified by:

add in interface Operation.Addition<N extends Comparable<N>>

Parameters:

addend - What to add

Returns:

this + addend

byteValue

public byte byteValue(long... ref)

Specified by:

byteValue in interface AccessAnyD<N extends Comparable<N>>

conjugate

public AnyTensor<N> conjugate()

Description copied from interface: VectorSpace

This method will (most likely) be moved to some other interface in the future! Just have to figure out where it fits...

The conjugate transpose of a matrix and/or the conjugate of a scalar/field like ComplexNumber or Quaternion.

The conjugate transpose of a real matrix is simply its transpose.

Specified by:

conjugate in interface VectorSpace<AnyTensor<N extends Comparable<N>>, N extends Comparable<N>>

count

public long count(int dimension)

Description copied from interface: StructureAnyD

count() == count(0) * count(1) * count(2) * count(3) * ...

Specified by:

count in interface StructureAnyD

doubleValue

public double doubleValue(int index)

Specified by:

doubleValue in interface Access1D<N extends Comparable<N>>

doubleValue

public double doubleValue(long... ref)

Specified by:

doubleValue in interface AccessAnyD<N extends Comparable<N>>

equals

public boolean equals(Object obj)

Overrides:

equals in class ArrayBasedTensor<N extends Comparable<N>, AnyTensor<N extends Comparable<N>>>

fillSet

public void fillSet(int dimension,
 long dimensionalIndex,
 N value)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Comparable<N>>

fillSet

public void fillSet(int dimension,
 long dimensionalIndex,
 NullaryFunction<?> supplier)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Comparable<N>>

fillSet

public void fillSet(long[] initial,
 int dimension,
 N value)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Comparable<N>>

fillSet

public void fillSet(long[] initial,
 int dimension,
 NullaryFunction<?> supplier)

Specified by:

fillSet in interface MutateAnyD.Fillable<N extends Comparable<N>>

floatValue

public float floatValue(long... ref)

Specified by:

floatValue in interface AccessAnyD<N extends Comparable<N>>

get

public N get(long... ref)

Specified by:

get in interface AccessAnyD<N extends Comparable<N>>

get

public N get(long index)

Specified by:

get in interface Access1D<N extends Comparable<N>>

hashCode

public int hashCode()

Overrides:

hashCode in class ArrayBasedTensor<N extends Comparable<N>, AnyTensor<N extends Comparable<N>>>

intValue

public int intValue(long... ref)

Specified by:

intValue in interface AccessAnyD<N extends Comparable<N>>

longValue

public long longValue(long... ref)

Specified by:

longValue in interface AccessAnyD<N extends Comparable<N>>

multiply

public AnyTensor<N> multiply(double scalarMultiplicand)

Specified by:

multiply in interface ScalarOperation.Multiplication<AnyTensor<N extends Comparable<N>>, N extends Comparable<N>>

Returns:

this * scalarMultiplicand.

multiply

public AnyTensor<N> multiply(N scalarMultiplicand)

Specified by:

multiply in interface ScalarOperation.Multiplication<AnyTensor<N extends Comparable<N>>, N extends Comparable<N>>

Returns:

this * multiplicand.

negate

public AnyTensor<N> negate()

Description copied from interface: Group.Additive

The additive inverse of this.

Specified by:

negate in interface Group.Additive<N extends Comparable<N>>

Returns:

-this.

norm

public double norm()

Description copied from interface: NormedVectorSpace

this == this.signum().multiply(this.norm())

Specified by:

norm in interface NormedVectorSpace<AnyTensor<N extends Comparable<N>>, N extends Comparable<N>>

Returns:

The norm

set

public void set(int index,
 double value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
 Comparable<?> value)

Specified by:

set in interface Mutate1D

set

public void set(long[] reference,
 byte value)

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
 Comparable<?> value)

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
 double value)

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
 float value)

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
 int value)

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
 long value)

Specified by:

set in interface MutateAnyD

set

public void set(long[] reference,
 short value)

Specified by:

set in interface MutateAnyD

shape

public long[] shape()

Specified by:

shape in interface StructureAnyD

shortValue

public short shortValue(long... ref)

Specified by:

shortValue in interface AccessAnyD<N extends Comparable<N>>

size

public int size()

Description copied from interface: Structure1D

The total number of elements in this structure.

Specified by:

size in interface Structure1D

size

public int size(int dimension)

Specified by:

size in interface StructureAnyD

toString

public String toString()

Overrides:

toString in class Object

getArray

ArrayAnyD<N> getArray()

newSameShape

AnyTensor<N> newSameShape()

Specified by:

newSameShape in class ArrayBasedTensor<N extends Comparable<N>, AnyTensor<N extends Comparable<N>>>