cern.colt.matrix.tdcomplex.algo

Class DComplexProperty

java.lang.Object

cern.colt.matrix.tdcomplex.algo.DComplexProperty

public class DComplexProperty
extends Object

Tests matrices for equality.

Except where explicitly indicated, all methods involving equality tests ( ==) allow for numerical instability, to a degree specified upon instance construction and returned by method tolerance(). The public static final variable DEFAULT represents a default Property object with a tolerance of 1.0E-9. The public static final variable ZERO represents a Property object with a tolerance of 0.0. The public static final variable TWELVE represents a Property object with a tolerance of 1.0E-12. As long as you are happy with these tolerances, there is no need to construct Property objects. Simply use idioms like Property.DEFAULT.equals(A,B), Property.ZERO.equals(A,B), Property.TWELVE.equals(A,B).

To work with a different tolerance (e.g. 1.0E-15 or 1.0E-5) use the constructor and/or method setTolerance(double). Note that the public static final Property objects are immutable: Is is not possible to alter their tolerance. Any attempt to do so will throw an Exception.

Note that this implementation is not synchronized.

Version:

1.1, 28/May/2000 (fixed strange bugs involving NaN, -inf, inf)

Author:

wolfgang.hoschek@cern.ch, Piotr Wendykier (piotr.wendykier@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static DComplexProperty	DEFAULT The default Property object; currently has tolerance()==1.0E-9.
static DComplexProperty	TWELVE A Property object with tolerance()==1.0E-12.
static DComplexProperty	ZERO A Property object with tolerance()==0.0.

Constructor Summary

Constructors

Constructor and Description
DComplexProperty(double newTolerance) Constructs an instance with a tolerance of Math.abs(newTolerance).

Method Summary

Methods

Modifier and Type	Method and Description
void	checkDense(DComplexMatrix1D A)
void	checkSparse(DComplexMatrix2D A)
void	checkSquare(DComplexMatrix2D A) Checks whether the given matrix A is square.
boolean	equals(DComplexMatrix1D A, DComplexMatrix1D B) Returns whether both given matrices A and B are equal.
boolean	equals(DComplexMatrix1D A, double[] value) Returns whether all cells of the given matrix A are equal to the given value.
boolean	equals(DComplexMatrix2D A, DComplexMatrix2D B) Returns whether both given matrices A and B are equal.
boolean	equals(DComplexMatrix2D A, double[] value) Returns whether all cells of the given matrix A are equal to the given value.
boolean	equals(DComplexMatrix3D A, DComplexMatrix3D B) Returns whether both given matrices A and B are equal.
boolean	equals(DComplexMatrix3D A, double[] value) Returns whether all cells of the given matrix A are equal to the given value.
void	setTolerance(double newTolerance) Sets the tolerance to Math.abs(newTolerance).
double	tolerance() Returns the current tolerance.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final DComplexProperty DEFAULT

The default Property object; currently has tolerance()==1.0E-9.

ZERO

public static final DComplexProperty ZERO

A Property object with tolerance()==0.0.

TWELVE

public static final DComplexProperty TWELVE

A Property object with tolerance()==1.0E-12.

Constructor Detail

DComplexProperty

public DComplexProperty(double newTolerance)

Constructs an instance with a tolerance of Math.abs(newTolerance).

Method Detail

setTolerance

public void setTolerance(double newTolerance)

Sets the tolerance to Math.abs(newTolerance).

Throws:

UnsupportedOperationException - if this==DEFAULT || this==ZERO || this==TWELVE.

tolerance

public double tolerance()

Returns the current tolerance.

checkDense

public void checkDense(DComplexMatrix1D A)

checkSquare

public void checkSquare(DComplexMatrix2D A)

Checks whether the given matrix A is square.

Throws:

IllegalArgumentException - if A.rows() != A.columns().

checkSparse

public void checkSparse(DComplexMatrix2D A)

equals

public boolean equals(DComplexMatrix1D A,
             double[] value)

Returns whether all cells of the given matrix A are equal to the given value.

Parameters:

A - the first matrix to compare.

value - the value to compare against.

Returns:

true if the matrix is equal to the value; false otherwise.

equals

public boolean equals(DComplexMatrix1D A,
             DComplexMatrix1D B)

Returns whether both given matrices A and B are equal.

Parameters:

A - the first matrix to compare.

B - the second matrix to compare.

Returns:

true if both matrices are equal; false otherwise.

equals

public boolean equals(DComplexMatrix2D A,
             double[] value)

Returns whether all cells of the given matrix A are equal to the given value.

Parameters:

A - the first matrix to compare.

value - the value to compare against.

Returns:

true if the matrix is equal to the value; false otherwise.

equals

public boolean equals(DComplexMatrix2D A,
             DComplexMatrix2D B)

Returns whether both given matrices A and B are equal.

Parameters:

A - the first matrix to compare.

B - the second matrix to compare.

Returns:

true if both matrices are equal; false otherwise.

equals

public boolean equals(DComplexMatrix3D A,
             double[] value)

Returns whether all cells of the given matrix A are equal to the given value.

Parameters:

A - the first matrix to compare.

value - the value to compare against.

Returns:

true if the matrix is equal to the value; false otherwise.

equals

public boolean equals(DComplexMatrix3D A,
             DComplexMatrix3D B)

Returns whether both given matrices A and B are equal.

Parameters:

A - the first matrix to compare.

B - the second matrix to compare.

Returns:

true if both matrices are equal; false otherwise.