Vectors (la4j 0.6.0 API)

java.lang.Object
- org.la4j.Vectors

public final class Vectors
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static VectorFactory<BasicVector>`	`BASIC`
`static VectorFactory<CompressedVector>`	`COMPRESSED`
`static VectorFunction`	`DEC_FUNCTION` Decreases each element of vectors by `1`.
`static VectorFactory<BasicVector>`	`DENSE`
`static double`	`EPS`
`static VectorFactory<?>[]`	`FACTORIES`
`static VectorFunction`	`INC_FUNCTION` Increases each element of vector by `1`.
`static VectorFunction`	`INV_FUNCTION` Inverts each element of vector.
`static VectorPredicate`	`NEGATIVE_VECTOR` Checks whether the vector is a negative vector.
`static VectorPredicate`	`POSITIVE_VECTOR` Checks whether the vector is a positive vector.
`static int`	`ROUND_FACTOR`
`static VectorFactory<CompressedVector>`	`SPARSE`
`static VectorPredicate`	`ZERO_VECTOR` Checks whether the vector is a zero vector.

Constructor Summary

Constructors
Constructor and Description

Vectors()

Constructors
Constructor and Description
`Vectors()`

Method Summary

Methods
Modifier and Type	Method and Description
`static VectorProcedure`	`asAccumulatorProcedure(VectorAccumulator accumulator)` Creates an accumulator procedure that adapts a vector accumulator for procedure interface.
`static VectorFunction`	`asConstFunction(double arg)` Creates a const function that evaluates it's argument to given `value`.
`static VectorFunction`	`asDivFunction(double arg)` Creates a div function that divides it's argument by given `value`.
`static VectorFunction`	`asMinusFunction(double arg)` Creates a minus function that subtracts given `value` from it's argument.
`static VectorFunction`	`asModFunction(double arg)` Creates a mod function that calculates the modulus of it's argument and given `value`.
`static VectorFunction`	`asMulFunction(double arg)` Creates a mul function that multiplies given `value` by it's argument.
`static VectorFunction`	`asPlusFunction(double arg)` Creates a plus function that adds given `value` to it's argument.
`static VectorAccumulator`	`asProductAccumulator(double neutral)` Creates a product vector accumulator that calculates the product of all elements in the vector.
`static VectorAccumulator`	`asProductFunctionAccumulator(double neutral, VectorFunction function)` Creates a product function accumulator, that calculates the product of all elements in the vector after applying given `function` to each of them.
`static VectorAccumulator`	`asSumAccumulator(double neutral)` Creates a sum vector accumulator that calculates the sum of all elements in the vector.
`static VectorAccumulator`	`asSumFunctionAccumulator(double neutral, VectorFunction function)` Creates a sum function accumulator, that calculates the sum of all elements in the vector after applying given `function` to each of them.
`static VectorAccumulator`	`mkEuclideanNormAccumulator()` Makes an Euclidean norm accumulator that allows to use `Vector.fold(org.la4j.vector.functor.VectorAccumulator)` method for norm calculation.
`static VectorAccumulator`	`mkInfinityNormAccumulator()` Makes an Infinity norm accumulator that allows to use `Vector.fold(org.la4j.vector.functor.VectorAccumulator)` method for norm calculation.
`static VectorAccumulator`	`mkManhattanNormAccumulator()` Makes a Manhattan norm accumulator that allows to use `Vector.fold(org.la4j.vector.functor.VectorAccumulator)` method for norm calculation.
`static VectorAccumulator`	`mkMaxAccumulator()` Makes a maximum vector accumulator that accumulates the maximum across vector elements.
`static VectorAccumulator`	`mkMinAccumulator()` Makes a minimum vector accumulator that accumulates the minimum across vector elements.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EPS
```
public static final double EPS
```
  - ROUND_FACTOR
```
public static final int ROUND_FACTOR
```
  - BASIC
```
public static final VectorFactory<BasicVector> BASIC
```
  - COMPRESSED
```
public static final VectorFactory<CompressedVector> COMPRESSED
```
  - FACTORIES
```
public static final VectorFactory<?>[] FACTORIES
```
  - DENSE
```
public static final VectorFactory<BasicVector> DENSE
```
  - SPARSE
```
public static final VectorFactory<CompressedVector> SPARSE
```
  - ZERO_VECTOR
```
public static final VectorPredicate ZERO_VECTOR
```
    Checks whether the vector is a zero vector.
  - POSITIVE_VECTOR
```
public static final VectorPredicate POSITIVE_VECTOR
```
    Checks whether the vector is a positive vector.
  - NEGATIVE_VECTOR
```
public static final VectorPredicate NEGATIVE_VECTOR
```
    Checks whether the vector is a negative vector.
  - INC_FUNCTION
```
public static final VectorFunction INC_FUNCTION
```
    Increases each element of vector by 1.
  - DEC_FUNCTION
```
public static final VectorFunction DEC_FUNCTION
```
    Decreases each element of vectors by 1.
  - INV_FUNCTION
```
public static final VectorFunction INV_FUNCTION
```
    Inverts each element of vector.
- Constructor Detail
  - Vectors
```
public Vectors()
```
- Method Detail
  - asConstFunction
```
public static VectorFunction asConstFunction(double arg)
```
    Creates a const function that evaluates it's argument to given value.
    
    Parameters:
    arg - a const value
    
    Returns:
    a closure object that does _
  - asPlusFunction
```
public static VectorFunction asPlusFunction(double arg)
```
    Creates a plus function that adds given value to it's argument.
    
    Parameters:
    arg - a value to be added to function's argument
    
    Returns:
    a closure object that does _ + _
  - asMinusFunction
```
public static VectorFunction asMinusFunction(double arg)
```
    Creates a minus function that subtracts given value from it's argument.
    
    Parameters:
    arg - a value to be subtracted from function's argument
    
    Returns:
    a closure that does _ - _
  - asMulFunction
```
public static VectorFunction asMulFunction(double arg)
```
    Creates a mul function that multiplies given value by it's argument.
    
    Parameters:
    arg - a value to be multiplied by function's argument
    
    Returns:
    a closure that does _ * _
  - asDivFunction
```
public static VectorFunction asDivFunction(double arg)
```
    Creates a div function that divides it's argument by given value.
    
    Parameters:
    arg - a divisor value
    
    Returns:
    a closure that does _ / _
  - asModFunction
```
public static VectorFunction asModFunction(double arg)
```
    Creates a mod function that calculates the modulus of it's argument and given value.
    
    Parameters:
    arg - a divisor value
    
    Returns:
    a closure that does _ % _
  - asSumAccumulator
```
public static VectorAccumulator asSumAccumulator(double neutral)
```
    Creates a sum vector accumulator that calculates the sum of all elements in the vector.
    
    Parameters:
    neutral - the neutral value
    
    Returns:
    a sum accumulator
  - asProductAccumulator
```
public static VectorAccumulator asProductAccumulator(double neutral)
```
    Creates a product vector accumulator that calculates the product of all elements in the vector.
    
    Parameters:
    neutral - the neutral value
    
    Returns:
    a product accumulator
  - mkMinAccumulator
```
public static VectorAccumulator mkMinAccumulator()
```
    Makes a minimum vector accumulator that accumulates the minimum across vector elements.
    
    Returns:
    a minimum vector accumulator
  - mkMaxAccumulator
```
public static VectorAccumulator mkMaxAccumulator()
```
    Makes a maximum vector accumulator that accumulates the maximum across vector elements.
    
    Returns:
    a maximum vector accumulator
  - mkEuclideanNormAccumulator
```
public static VectorAccumulator mkEuclideanNormAccumulator()
```
    Makes an Euclidean norm accumulator that allows to use Vector.fold(org.la4j.vector.functor.VectorAccumulator) method for norm calculation.
    
    Returns:
    an Euclidean norm accumulator
  - mkManhattanNormAccumulator
```
public static VectorAccumulator mkManhattanNormAccumulator()
```
    Makes a Manhattan norm accumulator that allows to use Vector.fold(org.la4j.vector.functor.VectorAccumulator) method for norm calculation.
    
    Returns:
    a Manhattan norm accumulator
  - mkInfinityNormAccumulator
```
public static VectorAccumulator mkInfinityNormAccumulator()
```
    Makes an Infinity norm accumulator that allows to use Vector.fold(org.la4j.vector.functor.VectorAccumulator) method for norm calculation.
    
    Returns:
    an Infinity norm accumulator
  - asSumFunctionAccumulator
```
public static VectorAccumulator asSumFunctionAccumulator(double neutral,
                                         VectorFunction function)
```
    Creates a sum function accumulator, that calculates the sum of all elements in the vector after applying given function to each of them.
    
    Parameters:
    neutral - the neutral value
    function - the vector function
    
    Returns:
    a sum function accumulator
  - asProductFunctionAccumulator
```
public static VectorAccumulator asProductFunctionAccumulator(double neutral,
                                             VectorFunction function)
```
    Creates a product function accumulator, that calculates the product of all elements in the vector after applying given function to each of them.
    
    Parameters:
    neutral - the neutral value
    function - the vector function
    
    Returns:
    a product function accumulator
  - asAccumulatorProcedure
```
public static VectorProcedure asAccumulatorProcedure(VectorAccumulator accumulator)
```
    Creates an accumulator procedure that adapts a vector accumulator for procedure interface. This is useful for reusing a single accumulator for multiple fold operations in multiple vectors.
    
    Parameters:
    accumulator - the vector accumulator
    
    Returns:
    an accumulator procedure

Class Vectors

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EPS

ROUND_FACTOR

BASIC

COMPRESSED

FACTORIES

DENSE

SPARSE

ZERO_VECTOR

POSITIVE_VECTOR

NEGATIVE_VECTOR

INC_FUNCTION

DEC_FUNCTION

INV_FUNCTION

Constructor Detail

Vectors

Method Detail

asConstFunction

asPlusFunction

asMinusFunction

asMulFunction

asDivFunction

asModFunction

asSumAccumulator

asProductAccumulator

mkMinAccumulator

mkMaxAccumulator

mkEuclideanNormAccumulator

mkManhattanNormAccumulator

mkInfinityNormAccumulator

asSumFunctionAccumulator

asProductFunctionAccumulator

asAccumulatorProcedure