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.Sliceable<N extends Comparable<N>>, AccessAnyD.Visitable<N extends Comparable<N>>

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

Access1D.ElementView<N extends Comparable<N>>

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.structure.Mutate1D

Mutate1D.Sortable

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

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

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

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

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

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

Method Summary

Modifier and Type	Method and Description
AnyTensor<N>	add(AnyTensor<N> addend)
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)
int	dimensions() The range of the indices that identify the scalar components.
double	doubleValue(long[] ref)
boolean	equals(Object obj)
static <N extends Comparable<N>> TensorFactoryAnyD<N,AnyTensor<N>>	factory(DenseArray.Factory<N> arrayFactory)
void	fillOne(long[] reference, N value)
void	fillOne(long[] reference, NullaryFunction<?> supplier)
void	fillOne(long index, Access1D<?> values, long valueIndex)
void	fillOne(long index, N value)
void	fillOne(long index, NullaryFunction<?> supplier)
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)
N	get(long[] ref)
int	hashCode()
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())
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(long[] reference, Comparable<?> value)
void	set(long[] reference, double value)
long[]	shape()
T	signum() this == this.signum().multiply(this.norm())
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.structure.AccessAnyD

asCollectableAnyD, asPrimitiveAnyD, byteValue, byteValue, doubleValue, equals, floatValue, floatValue, get, intValue, intValue, longValue, longValue, matrices, shortValue, shortValue, toString, vectors

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asPrimitive1D, axpy, dot, elements, equals, hashCode, nonzeros, supplyTo, toRawCopy1D, toString, wrap, wrap, wrap

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

accept, isAcceptable

Methods inherited from interface org.ojalgo.structure.MutateAnyD

set, set, set, set

Methods inherited from interface org.ojalgo.structure.Mutate1D

copyComplexArgument, copyComplexImaginary, copyComplexModulus, copyComplexModulusAndArgument, copyComplexReal, copyComplexRealAndImaginary, reset

Methods inherited from interface org.ojalgo.structure.StructureAnyD

count, count, count, count, count, index, index, loop, loop, loop, loopAll, loopMatching, mapperOf, rank, reference, shape, step, step, step, step

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

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

Methods inherited from interface org.ojalgo.structure.Structure1D

index, loopAll, loopMatching, loopRange, mapper, size, toIntIndexes

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.ojalgo.tensor.Tensor

components, isSameShape

Methods inherited from interface org.ojalgo.algebra.NormedVectorSpace

isSmall

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

multiply

Method Detail

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<AnyTensor<N extends Comparable<N>>>

Parameters:

addend - What to add

Returns:

this + addend

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)

Specified by:

count in interface StructureAnyD

doubleValue

public double doubleValue(long[] ref)

Specified by:

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

equals

public boolean equals(Object obj)

fillOne

public void fillOne(long index,
                    Access1D<?> values,
                    long valueIndex)

Specified by:

fillOne in interface Mutate1D.Fillable<N extends Comparable<N>>

fillOne

public void fillOne(long index,
                    N value)

Specified by:

fillOne in interface Mutate1D.Fillable<N extends Comparable<N>>

fillOne

public void fillOne(long index,
                    NullaryFunction<?> supplier)

Specified by:

fillOne in interface Mutate1D.Fillable<N extends Comparable<N>>

fillOne

public void fillOne(long[] reference,
                    N value)

Specified by:

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

fillOne

public void fillOne(long[] reference,
                    NullaryFunction<?> supplier)

Specified by:

fillOne in interface MutateAnyD.Fillable<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>>

get

public N get(long[] ref)

Specified by:

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

hashCode

public int hashCode()

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<AnyTensor<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(long[] reference,
                Comparable<?> value)

Specified by:

set in interface MutateAnyD

set

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

Specified by:

set in interface MutateAnyD

shape

public long[] shape()

Specified by:

shape 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 T signum()

Description copied from interface: NormedVectorSpace

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

Specified by:

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

Returns:

A unit "vector"