Module flag4j

Package org.flag4j.linalg

Class VectorNorms

java.lang.Object

org.flag4j.linalg.VectorNorms

public final class VectorNorms
extends Object

Utility class for computing norms of vectors.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	VectorNorms()

Method Summary

Modifier and Type	Method	Description
static double	norm(double... src)	Computes the 2-norm of a vector.
static double	norm(double[] src, double p)	Computes the p-norm of a vector.
static double	norm(Complex128... src)	Deprecated.
static double	norm(Complex128[] src, double p)	Deprecated.
static double	norm(Field... src)	Computes the 2-norm of a vector.
static double	norm(Field[] src, double p)	Computes the p-norm of a vector.
static double	norm(CVector src)	Deprecated.
static double	norm(CVector src, double p)	Deprecated.
static <T extends Field<T>> double	norm(FieldVector<T> src)	Computes the 2-norm of this vector.
static <T extends Field<T>> double	norm(FieldVector<T> src, double p)	Computes the p-norm of this vector.
static double	norm(Vector src)	Computes the 2-norm of this vector.
static double	norm(Vector src, double p)	Computes the p-norm of this vector.
static double	norm(CooCVector src)	Computes the 2-norm of this vector.
static double	norm(CooCVector src, double p)	Computes the p-norm of this vector.
static double	norm(CooVector src)	Computes the 2-norm of this vector.
static double	norm(CooVector src, double p)	Computes the p-norm of this vector.

Methods inherited from class java.lang.Object

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

Constructor Details

VectorNorms

private VectorNorms()

Method Details

norm

public static double norm(Vector src)

Computes the 2-norm of this vector. This is equivalent to norm(src, 2).

Parameters:

src - Vector to compute norm of.

Returns:

the 2-norm of this vector.

norm

public static double norm(Vector src,
 double p)

Computes the p-norm of this vector.

Parameters:

src - Vector to compute norm of.

p - The p value in the p-norm.
- If p is inf, then this method computes the maximum/infinite norm.

Returns:

The p-norm of this vector.

Throws:

IllegalArgumentException - If p is less than 1.

norm

public static double norm(CooVector src)

Computes the 2-norm of this vector. This is equivalent to norm(2).

Parameters:

src - Vector to compute norm of.

Returns:

the 2-norm of this vector.

norm

public static double norm(CooVector src,
 double p)

Computes the p-norm of this vector.

Parameters:

src - Vector to compute norm of.

p - The p value in the p-norm.
- If p is inf, then this method computes the maximum/infinite norm.

Returns:

The p-norm of this vector.

Throws:

IllegalArgumentException - If p is less than 1.

norm

@Deprecated
public static double norm(CVector src)

Deprecated.

Computes the 2-norm of this vector. This is equivalent to norm(2).

Returns:

the 2-norm of this vector.

norm

@Deprecated
public static double norm(CVector src,
 double p)

Deprecated.

Computes the p-norm of this vector. Warning, if p is large in absolute value, overflow issues may occur.

Parameters:

p - The p value in the p-norm.
- If p is Double.POSITIVE_INFINITY, then this method computes the maximum/infinite norm.
- If p is Double.NEGATIVE_INFINITY, then this method computes the minimum norm.

Returns:

The p-norm of this vector.

norm

public static <T extends Field<T>> double norm(FieldVector<T> src)

Computes the 2-norm of this vector. This is equivalent to norm(2).

Returns:

the 2-norm of this vector.

norm

public static <T extends Field<T>> double norm(FieldVector<T> src,
 double p)

Computes the p-norm of this vector. Warning, if p is large in absolute value, overflow issues may occur.

Parameters:

p - The p value in the p-norm:

• If p is Double.POSITIVE_INFINITY, then this method computes the maximum/infinite norm.
• If p is Double.NEGATIVE_INFINITY, then this method computes the minimum norm.

Returns:

The p-norm of this vector.

norm

public static double norm(CooCVector src)

Computes the 2-norm of this vector. This is equivalent to norm(src, 2).

Parameters:

src - Vector to compute norm of.

Returns:

the 2-norm of this vector.

norm

public static double norm(CooCVector src,
 double p)

Computes the p-norm of this vector.

Parameters:

src - Vector to compute norm of.

p - The p value in the p-norm.
- If p is inf, then this method computes the maximum/infinite norm.

Returns:

The p-norm of this vector.

Throws:

IllegalArgumentException - If p is less than 1.

norm

public static double norm(double... src)

Computes the 2-norm of a vector.

Parameters:

src - Entries of the vector (or non-zero entries if vector is sparse).

Returns:

The 2-norm of the vector.

norm

@Deprecated
public static double norm(Complex128... src)

Deprecated.

Computes the 2-norm of a vector.

Parameters:

src - Entries of the vector (or non-zero entries if vector is sparse).

Returns:

The 2-norm of the vector.

norm

public static double norm(Field... src)

Computes the 2-norm of a vector.

Parameters:

src - Entries of the vector (or non-zero entries if vector is sparse).

Returns:

The 2-norm of the vector.

norm

public static double norm(double[] src,
 double p)

Computes the p-norm of a vector.

Parameters:

src - Entries of the vector (or non-zero entries if vector is sparse).

p - The p value in the p-norm:

• If p is Double.POSITIVE_INFINITY, then this method computes the maximum/infinite norm.
• If p is Double.NEGATIVE_INFINITY, then this method computes the minimum norm.

Warning, if p is very large in absolute value, overflow errors may occur.

Returns:

The p-norm of the vector.

norm

@Deprecated
public static double norm(Complex128[] src,
 double p)

Deprecated.

Computes the p-norm of a vector.

Parameters:

src - Entries of the vector (or non-zero entries if vector is sparse).

p - The p value in the p-norm.
- If p is Double.POSITIVE_INFINITY, then this method computes the maximum/infinite norm.
- If p is Double.NEGATIVE_INFINITY, then this method computes the minimum norm.
Warning, if p is large in absolute value, overflow errors may occur.

Returns:

The p-norm of the vector.

norm

public static double norm(Field[] src,
 double p)

Computes the p-norm of a vector.

Parameters:

src - Entries of the vector (or non-zero entries if vector is sparse).

p - The p value in the p-norm.
- If p is Double.POSITIVE_INFINITY, then this method computes the maximum/infinite norm.
- If p is Double.NEGATIVE_INFINITY, then this method computes the minimum norm.
Warning, if p is large in absolute value, overflow errors may occur.

Returns:

The p-norm of the vector.