com.rubecula.jquantity
Interface Imaginable

All Known Implementing Classes:

Complex

public interface Imaginable

Imaginable: the interface which defines complex operations. Similar to the Divisible interface.

Copyright: Copyright (c) 2003

Company: Rubecula Software

Since:

V_0_3

Version:

$Revision: 1.3 $

Author:

Robin Hillyard

Method Summary

Imaginable	complement() Method to determine the complex complement (i.e. the conjugate) of this Imaginable.
Value	magnitude() Method to determine the magnitude of this Imaginable.
Value	phase() Method to determine the phase, also known as the argument, of this Imaginable.
Imaginable	rotate(Value angle) Method to rotate this (in Complex space).

Method Detail

complement

public Imaginable complement()

Method to determine the complex complement (i.e. the conjugate) of this Imaginable.

Returns:

An Imaginable which is equivalent in magnitude as this, but with phase that is the negative of this.

rotate

public Imaginable rotate(Value angle)

Method to rotate this (in Complex space). The resulting value has the same magnitude as this, but has a phase with is incremented by phase.

Parameters:

angle - the angle by which this is to be rotated (counter-clockwise).

Returns:

An Imaginable which is equivalent in magnitude as this, but with phase that is the negative of this.

magnitude

public Value magnitude()

Method to determine the magnitude of this Imaginable.

Returns:

the magnitude.

phase

public Value phase()

Method to determine the phase, also known as the argument, of this Imaginable.

Returns:

the phase as a multiple of pi.