org.ojalgo.matrix.task.iterative

Class Equation

java.lang.Object

org.ojalgo.matrix.task.iterative.Equation

All Implemented Interfaces:

Comparable<Equation>, Access1D<Double>, Mutate1D, Structure1D

public final class Equation
extends Object
implements Comparable<Equation>, Access1D<Double>, Mutate1D

Nested Class Summary

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

Access1D.Aggregatable<N extends Number>, Access1D.Collectable<N extends Number,R extends Mutate1D.Receiver<N>>, Access1D.Elements, Access1D.ElementView<N extends Number>, Access1D.IndexOf, Access1D.Sliceable<N extends Number>, Access1D.Visitable<N extends Number>

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

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

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

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

Field Summary

Fields

Modifier and Type	Field and Description
int	index The row index of the original body matrix, [A].

Constructor Summary

Constructors

Constructor and Description
Equation(int row, long numberOfColumns, double rhs)
Equation(int row, long numberOfColumns, double rhs, int numberOfNonzeros)

Method Summary

Modifier and Type	Method and Description
void	add(long index, double addend)
void	add(long index, Number addend)
double	adjust(PhysicalStore<Double> x, double relaxation) Will perform a (relaxed) GaussSeidel update.
int	compareTo(Equation other)
long	count()
double	dot(Access1D<?> vector) Will calculate and return the dot product of this 1D-structure and another input 1D-vector.
double	doubleValue(long index)
boolean	equals(Object obj)
Double	get(long index)
double	getPivot()
double	getRHS()
int	hashCode()
void	initialise(PhysicalStore<Double> x)
void	set(long index, double value)
void	set(long index, Number value)
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, asPrimitive1D, axpy, byteValue, elements, equals, floatValue, hashCode, intValue, longValue, nonzeros, shortValue, supplyTo, toRawCopy1D, toString, wrap, wrap, wrap

Methods inherited from interface org.ojalgo.structure.Mutate1D

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

Methods inherited from interface org.ojalgo.structure.Structure1D

index, loopAll, loopMatching, loopRange, mapper, size

Field Detail

index

public final int index

The row index of the original body matrix, [A].

Constructor Detail

Equation

public Equation(int row,
                long numberOfColumns,
                double rhs)

Equation

public Equation(int row,
                long numberOfColumns,
                double rhs,
                int numberOfNonzeros)

Method Detail

add

public void add(long index,
                double addend)

Specified by:

add in interface Mutate1D

add

public void add(long index,
                Number addend)

Specified by:

add in interface Mutate1D

adjust

public double adjust(PhysicalStore<Double> x,
                     double relaxation)

Will perform a (relaxed) GaussSeidel update.

Parameters:

x - The current solution (one element will be updated)

relaxation - Typically 1.0 but could be anything (Most likely should be between 0.0 and 2.0).

Returns:

The error in this equation

compareTo

public int compareTo(Equation other)

Specified by:

compareTo in interface Comparable<Equation>

count

public long count()

Specified by:

count in interface Structure1D

Returns:

The total number of elements in this structure.

dot

public double dot(Access1D<?> vector)

Description copied from interface: Access1D

Will calculate and return the dot product of this 1D-structure and another input 1D-vector.

Specified by:

dot in interface Access1D<Double>

Parameters:

vector - Another 1D-structure

Returns:

The dot product

doubleValue

public double doubleValue(long index)

Specified by:

doubleValue in interface Access1D<Double>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

get

public Double get(long index)

Specified by:

get in interface Access1D<Double>

getPivot

public double getPivot()

Returns:

The element at index

getRHS

public double getRHS()

Returns:

The equation RHS

hashCode

public int hashCode()

Overrides:

hashCode in class Object

initialise

public void initialise(PhysicalStore<Double> x)

set

public void set(long index,
                double value)

Specified by:

set in interface Mutate1D

set

public void set(long index,
                Number value)

Specified by:

set in interface Mutate1D

toString

public String toString()

Overrides:

toString in class Object