Module ojalgo

Package org.ojalgo.tensor

Class AnyTensor<N extends Comparable<N>>

java.lang.Object

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 Object
implements AccessAnyD<N>, MutateAnyD.Receiver<N>

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.structure.AccessAnyD

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

Nested classes/interfaces inherited from interface org.ojalgo.algebra.Group

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

Nested classes/interfaces inherited from interface org.ojalgo.structure.Mutate1D

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

Nested classes/interfaces inherited from interface org.ojalgo.structure.MutateAnyD

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

Nested classes/interfaces inherited from interface org.ojalgo.algebra.Operation

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

Nested classes/interfaces inherited from interface org.ojalgo.algebra.ScalarOperation

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

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D

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

Nested classes/interfaces inherited from interface org.ojalgo.structure.StructureAnyD

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

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!
long	count(int dimension)	count() == count(0) * count(1) * count(2) * count(3) * ...
final int	dimensions()	The range of the indices that identify the scalar components.
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)
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.
double	norm()	this == this.signum().multiply(this.norm())
final int	rank()	The total number of indices required to uniquely identify each scalar component is called the order, degree or rank of the tensor.
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)
AnyTensor<N>	signum()	this == this.signum().multiply(this.norm())
int	size()	The total number of elements in this structure.
int	size(int dimension)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.structure.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 org.ojalgo.structure.AccessAnyD

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.ojalgo.structure.Mutate1D

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

Methods inherited from interface org.ojalgo.structure.Mutate1D.Fillable

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

Methods inherited from interface org.ojalgo.structure.MutateAnyD

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

Methods inherited from interface org.ojalgo.structure.MutateAnyD.Fillable

fillCompatible

Methods inherited from interface org.ojalgo.structure.MutateAnyD.Receiver

accept, isAcceptable

Methods inherited from interface org.ojalgo.algebra.NormedVectorSpace

isSmall

Methods inherited from interface org.ojalgo.algebra.ScalarOperation.Multiplication

multiply

Methods inherited from interface org.ojalgo.structure.Structure1D

count

Methods inherited from interface org.ojalgo.structure.StructureAnyD

loop, loop, loopAllReferences, loopReferences, rank

Methods inherited from interface org.ojalgo.tensor.Tensor

components, isSameShape

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)

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()

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

dimensions

public final int dimensions()

Description copied from interface: Tensor

The range of the indices that identify the scalar components. Each index of a tensor ranges over the number of dimensions.

Specified by:

dimensions in interface Tensor<N extends Comparable<N>,T extends org.ojalgo.tensor.ArrayBasedTensor<N,T>>

rank

public final int rank()

Description copied from interface: Tensor

The total number of indices required to uniquely identify each scalar component is called the order, degree or rank of the tensor.

Specified by:

rank in interface Tensor<N extends Comparable<N>,T extends org.ojalgo.tensor.ArrayBasedTensor<N,T>>

signum

public AnyTensor<N> signum()

Description copied from interface: NormedVectorSpace

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

Specified by:

signum in interface NormedVectorSpace<N extends Comparable<N>,T extends org.ojalgo.tensor.ArrayBasedTensor<N,T>>

Returns:

A unit "vector"