triana.types

Interface Arithmetic

All Known Implementing Classes:

ComplexSampleSet, ComplexSpectrum, Const, Curve, GraphType, Histogram, MatrixType, MultipleAudio, MultipleChannel, MultipleSpectra, SampleSet, Spectrum, Spectrum2D, TimeFrequency, VectorType

public interface Arithmetic

Arithmetic is an Interface that should be implemented by any Triana data types that need to define standard arithmetic: adding, subtracting, multiplying, and dividing the current object by another. The Arithmetic interface also provides a compatibility test: isCompatible ensures that an object to be combined with the current object has an acceptable type and contents, as decided by the programmer for the type that implements the interface. The interface also provides the test equals which tests for strict equality of the argument and current objects. Programmers should normally implement the interface in such a way that arithmetic is provided at least between objects of the same class and with objects of the class Const.

See Also:

TrianaType, GraphType, Const

Method Summary

Methods

Modifier and Type	Method and Description
Arithmetic	add(java.lang.Object obj) Adds the argument object to the current object.
Arithmetic	divide(java.lang.Object obj) Divides the current object by the argument object.
boolean	equals(java.lang.Object obj) Tests if the argument object is equal to the current object.
boolean	isCompatible(java.lang.Object obj) Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object.
Arithmetic	multiply(java.lang.Object obj) Multiplies the current object by the argument object.
Arithmetic	subtract(java.lang.Object obj) Subtracts the argument object from the current object.

Method Detail

isCompatible

boolean isCompatible(java.lang.Object obj)

Tests the argument object to determine if it makes sense to perform arithmetic operations between it and the current object. The definition of compatibility is up to the programmer who implements the interface, but it should test not only that the object is of a suitable type but also that its data are compatible: arrays of the same size, etc. It can be used in the arithmetic methods to provide a graceful exit if the two objects cannot sensibly be combined.

Parameters:

obj - The data object to be compared with the current one

Returns:

boolean True if the object can be combined with the current one

equals

boolean equals(java.lang.Object obj)

Tests if the argument object is equal to the current object. The definition of "equal" is up to the programmer who implements the interface.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The data object to be compared with the current one

Returns:

boolean True if the object equals the current one

add

Arithmetic add(java.lang.Object obj)
               throws java.lang.ClassCastException

Adds the argument object to the current object. Users should invoke method isCompatible to test whether this operation makes sense.

Parameters:

obj - The new data object to be added to the current one

Returns:

the object representing result of the addition. The object should be the same type as the original current.

Throws:

java.lang.ClassCastException - if addition with the specified object is not valid

subtract

Arithmetic subtract(java.lang.Object obj)
                    throws java.lang.ClassCastException

Subtracts the argument object from the current object. Users should invoke method isCompatible to test whether this operation makes sense.

Parameters:

obj - The new data object to be subtracted from the current one

Returns:

the object representing result of the subtraction. The object should be the same type as the original current.

Throws:

java.lang.ClassCastException - if subtraction with the specified object is not valid

multiply

Arithmetic multiply(java.lang.Object obj)
                    throws java.lang.ClassCastException

Multiplies the current object by the argument object. It should invoke method isCompatible to test whether this operation makes sense.

Parameters:

obj - The new data object to be multiplied into the current one

Returns:

the object representing result of the multiplication. The object should be the same type as the original current.

Throws:

java.lang.ClassCastException - if multiplication with the specified object is not valid

divide

Arithmetic divide(java.lang.Object obj)
                  throws java.lang.ClassCastException

Divides the current object by the argument object. It should invoke method isCompatible to test whether this operation makes sense.

Parameters:

obj - The new data object to be divided into the current one

Returns:

the object representing result of the division. The object should be the same type as the original current.

Throws:

java.lang.ClassCastException - if division with the specified object is not valid