Module ojalgo

Package org.ojalgo.tensor

Class VectorTensor<N extends Comparable<N>>

java.lang.Object

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

org.ojalgo.tensor.VectorTensor<N>

All Implemented Interfaces:

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

public final class VectorTensor<N extends Comparable<N>>
extends ArrayBasedTensor<N,VectorTensor<N>>
implements Access1D<N>, Mutate1D.Receiver<N>

Nested Class Summary

Nested Classes

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

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

Access1D.Aggregatable<N extends Comparable<N>>, Access1D.Collectable<N extends Comparable<N>,R extends Mutate1D>, Access1D.ElementView<N extends Comparable<N>>, Access1D.SelectionView<N extends Comparable<N>>, Access1D.Sliceable<N extends Comparable<N>>, Access1D.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.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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
VectorTensor(Array1D.Factory<N> factory, int dimensions)

Method Summary

Modifier and Type	Method	Description
VectorTensor<N>	add(VectorTensor<N> addend)
byte	byteValue(int index)
byte	byteValue(long index)
VectorTensor<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()	The total number of elements in this structure.
double	doubleValue(int index)
double	doubleValue(long index)
boolean	equals(Object obj)
static <N extends Comparable<N>> TensorFactory1D<N,VectorTensor<N>>	factory(DenseArray.Factory<N,?> arrayFactory)
float	floatValue(int index)
float	floatValue(long index)
N	get(long index)
(package private) Array1D<N>	getArray()
int	hashCode()
int	intValue(int index)
int	intValue(long index)
long	longValue(int index)
long	longValue(long index)
VectorTensor<N>	multiply(double scalarMultiplicand)
VectorTensor<N>	multiply(N scalarMultiplicand)
VectorTensor<N>	negate()	The additive inverse of this.
(package private) VectorTensor<N>	newSameShape()
double	norm()	this == this.signum().multiply(this.norm())
void	set(int index, byte value)
void	set(int index, double value)
void	set(int index, float value)
void	set(int index, int value)
void	set(int index, long value)
void	set(int index, short value)
void	set(long index, byte value)
void	set(long index, double value)
void	set(long index, float value)
void	set(long index, int value)
void	set(long index, long value)
void	set(long index, short value)
void	set(long index, Comparable<?> value)
short	shortValue(int index)
short	shortValue(long index)
int	size()	The total number of elements in this structure.
String	toString()

Methods inherited from class org.ojalgo.tensor.ArrayBasedTensor

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

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, dot, elements, nonzeros, select, supplyTo, toList, toRawCopy1D

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.ojalgo.structure.Mutate1D

reset

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.Mutate1D.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.tensor.Tensor

components, isSameShape

Field Details

myArray

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

myFactory

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

Constructor Details

VectorTensor

VectorTensor(Array1D.Factory<N> factory,
 int dimensions)

Method Details

factory

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

add

public VectorTensor<N> add(VectorTensor<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(int index)

Specified by:

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

byteValue

public byte byteValue(long index)

Specified by:

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

conjugate

public VectorTensor<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<VectorTensor<N extends Comparable<N>>,N extends Comparable<N>>

count

public long count()

Description copied from interface: Structure1D

The total number of elements in this structure.

You only need to implement this method if the structure can contain more than Integer.MAX_VALUE elements.

Specified by:

count in interface Structure1D

doubleValue

public double doubleValue(int index)

Specified by:

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

doubleValue

public double doubleValue(long index)

Specified by:

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

equals

public boolean equals(Object obj)

Overrides:

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

floatValue

public float floatValue(int index)

Specified by:

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

floatValue

public float floatValue(long index)

Specified by:

floatValue in interface Access1D<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>,VectorTensor<N extends Comparable<N>>>

intValue

public int intValue(int index)

Specified by:

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

intValue

public int intValue(long index)

Specified by:

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

longValue

public long longValue(int index)

Specified by:

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

longValue

public long longValue(long index)

Specified by:

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

multiply

public VectorTensor<N> multiply(double scalarMultiplicand)

Specified by:

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

Returns:

this * scalarMultiplicand.

multiply

public VectorTensor<N> multiply(N scalarMultiplicand)

Specified by:

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

Returns:

this * multiplicand.

negate

public VectorTensor<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<VectorTensor<N extends Comparable<N>>,N extends Comparable<N>>

Returns:

The norm

set

public void set(int index,
 byte value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 double value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 float value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 int value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 long value)

Specified by:

set in interface Mutate1D

set

public void set(int index,
 short value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
 byte 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 index,
 double value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
 float value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
 int value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
 long value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
 short value)

Specified by:

set in interface Mutate1D

shortValue

public short shortValue(int index)

Specified by:

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

shortValue

public short shortValue(long index)

Specified by:

shortValue in interface Access1D<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

toString

public String toString()

Overrides:

toString in class Object

getArray

Array1D<N> getArray()

newSameShape

VectorTensor<N> newSameShape()

Specified by:

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