Package com.irurueta.algebra

Class OneNormComputer

java.lang.Object

com.irurueta.algebra.NormComputer

com.irurueta.algebra.OneNormComputer

public class OneNormComputer
extends NormComputer

Class in charge of computing one norms of arrays and matrices. One norm is defined as the maximum column sum on a matrix or array. For the case of arrays, this library considers arrays as column matrices with one column and array length rows.

Field Summary

Fields inherited from class com.irurueta.algebra.NormComputer

DEFAULT_NORM_TYPE

Constructor Summary

Constructors

Constructor	Description
OneNormComputer()	Constructor of this class.

Method Summary

Modifier and Type	Method	Description
double	getNorm(double[] array)	Computes norm of provided array.
double	getNorm(Matrix m)	Computes norm of provided matrix.
NormType	getNormType()	Returns norm type being used by this class.
static double	norm(double[] array)	Computes norm of provided array.
static double	norm(double[] array, Matrix jacobian)	Computes norm of provided array and stores the jacobian into provided instance.
static double	norm(Matrix m)	Computes norm of provided matrix.

Methods inherited from class com.irurueta.algebra.NormComputer

create, create, getNorm

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OneNormComputer

public OneNormComputer()

Constructor of this class.

Method Details

getNormType

public NormType getNormType()

Returns norm type being used by this class.

Specified by:

getNormType in class NormComputer

Returns:

Norm type being used by this class.

norm

public static double norm(Matrix m)

Computes norm of provided matrix.

Parameters:

m - matrix being used for norm computation.

Returns:

norm of provided matrix.

getNorm

public double getNorm(Matrix m)

Computes norm of provided matrix.

Specified by:

getNorm in class NormComputer

Parameters:

m - Matrix being used for norm computation.

Returns:

Norm of provided matrix.

norm

public static double norm(double[] array)

Computes norm of provided array.

Parameters:

array - array being used for norm computation.

Returns:

norm of provided vector.

norm

public static double norm(double[] array,
 Matrix jacobian)
                   throws WrongSizeException

Computes norm of provided array and stores the jacobian into provided instance.

Parameters:

array - array being used for norm computation.

jacobian - instance where jacobian will be stored. Must be 1xN, where N is length of array.

Returns:

norm of provided vector.

Throws:

WrongSizeException - if provided jacobian is not 1xN, where N is length of array.

getNorm

public double getNorm(double[] array)

Computes norm of provided array.

Specified by:

getNorm in class NormComputer

Parameters:

array - Array being used for norm computation.

Returns:

Norm of provided vector.