Package org.flag4j.linalg

Class TensorNorms

java.lang.Object

org.flag4j.linalg.TensorNorms

public class TensorNorms
extends Object

Utility class for computing "norms" of tensors.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TensorNorms()

Method Summary

Modifier and Type	Method	Description
double	infNorm(CTensor src)	Computes the maximum/infinite norm of this tensor.
static double	infNorm(ComplexDenseTensorBase<?,?> src)	Computes the infinity norm of a tensor, matrix, or vector.
static double	infNorm(RealDenseTensorBase<?,?> src)	Computes the infinity norm of a tensor, matrix, or vector.
double	norm(CTensor src)	Computes the 2-norm of this tensor.
double	norm(CTensor src, double p)	Computes the p-norm of this tensor.
static double	norm(Tensor src)	Computes the 2-norm of this tensor as if the tensor was a vector (i.e.
static double	norm(Tensor src, double p)	Computes the p-norm of this tensor.
static double	norm(CooCTensor src)	Computes the 2-norm of this tensor.
double	norm(CooCTensor src, double p)	Computes the p-norm of this tensor.
static double	norm(CooTensor src)	Computes the 2-norm of this tensor.
double	norm(CooTensor src, double p)	Computes the p-norm of this tensor.
protected static double	tensorNormL2(double[] src)	Computes the L2 norm of a tensor.
static double	tensorNormL2(CNumber[] src)	Computes the L2 norm of a tensor (i.e.
protected static double	tensorNormLp(double[] src, double p)	Computes the Lp norm of a tensor.
static double	tensorNormLp(CNumber[] src, double p)	Computes the Lp norm of a tensor (i.e.

Methods inherited from class java.lang.Object

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

Constructor Details

TensorNorms

private TensorNorms()

Method Details

infNorm

public static double infNorm(RealDenseTensorBase<?,?> src)

Computes the infinity norm of a tensor, matrix, or vector. That is, the largest absolute value.

Parameters:

src - The tensor, matrix, or vector to compute the norm of.

Returns:

The infinity norm of the source tensor, matrix, or vector.

infNorm

public static double infNorm(ComplexDenseTensorBase<?,?> src)

Computes the infinity norm of a tensor, matrix, or vector. That is, the largest value by magnitude.

Parameters:

src - The tensor, matrix, or vector to compute the norm of.

Returns:

The infinity norm of the source tensor, matrix, or vector.

norm

public static double norm(Tensor src)

Computes the 2-norm of this tensor as if the tensor was a vector (i.e. as if by VectorNorm(Tensor.toVector())). This is equivalent to norm(src, 2).

Parameters:

src - Tensor to compute norm of.

Returns:

the 2-norm of this tensor.

norm

public static double norm(Tensor src,
 double p)

Computes the p-norm of this tensor.

Parameters:

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

Throws:

IllegalArgumentException - If p is less than 1.

norm

public double norm(CTensor src)

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

Returns:

the 2-norm of this tensor.

norm

public double norm(CTensor src,
 double p)

Computes the p-norm of this tensor.

Parameters:

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

Throws:

IllegalArgumentException - If p is less than 1.

infNorm

public double infNorm(CTensor src)

Computes the maximum/infinite norm of this tensor.

Parameters:

src - Tensor to compute norm of.

Returns:

The maximum/infinite norm of this tensor.

norm

public static double norm(CooTensor src)

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

Parameters:

src - Tensor to compute norm of.

Returns:

the 2-norm of this tensor.

norm

public double norm(CooTensor src,
 double p)

Computes the p-norm of this tensor.

Parameters:

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

Throws:

IllegalArgumentException - If p is less than 1.

norm

public static double norm(CooCTensor src)

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

Parameters:

src - Tensor to compute norm of.

Returns:

the 2-norm of this tensor.

norm

public double norm(CooCTensor src,
 double p)

Computes the p-norm of this tensor.

Parameters:

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

Throws:

IllegalArgumentException - If p is less than 1.

tensorNormL2

protected static double tensorNormL2(double[] src)

Computes the L₂ norm of a tensor.

Parameters:

src - Entries of the tensor.

Returns:

The L₂ norm of the tensor.

tensorNormLp

protected static double tensorNormLp(double[] src,
 double p)

Computes the L_p norm of a tensor.

Parameters:

src - Entries of the tensor.

p - The p parameter of the L_p norm.

Returns:

The L_p norm of the tensor.

tensorNormL2

public static double tensorNormL2(CNumber[] src)

Computes the L₂ norm of a tensor (i.e. the Frobenius norm).

Parameters:

src - Entries of the tensor.

Returns:

The L₂ norm of the tensor.

tensorNormLp

public static double tensorNormLp(CNumber[] src,
 double p)

Computes the L_p norm of a tensor (i.e. the Frobenius norm).

Parameters:

src - Entries of the tensor.

p - The p parameter of the L_p norm.

Returns:

The L_p norm of the tensor.