Package org.apache.commons.math.complex
Class ComplexFormat
java.lang.Object
java.text.Format
org.apache.commons.math.util.CompositeFormat
org.apache.commons.math.complex.ComplexFormat
- All Implemented Interfaces:
Serializable
,Cloneable
Formats a Complex number in cartesian format "Re(c) + Im(c)i". 'i' can
be replaced with 'j' (or anything else), and the number format for both real
and imaginary parts can be configured.
- Version:
- $Revision: 983921 $ $Date: 2010-08-10 12:46:06 +0200 (mar. 10 août 2010) $
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.Format
Format.Field
-
Constructor Summary
ConstructorsConstructorDescriptionCreate an instance with the default imaginary character, 'i', and the default number format for both real and imaginary parts.ComplexFormat
(String imaginaryCharacter) Create an instance with a custom imaginary character, and the default number format for both real and imaginary parts.ComplexFormat
(String imaginaryCharacter, NumberFormat format) Create an instance with a custom imaginary character, and a custom number format for both real and imaginary parts.ComplexFormat
(String imaginaryCharacter, NumberFormat realFormat, NumberFormat imaginaryFormat) Create an instance with a custom imaginary character, a custom number format for the real part, and a custom number format for the imaginary part.ComplexFormat
(NumberFormat format) Create an instance with a custom number format for both real and imaginary parts.ComplexFormat
(NumberFormat realFormat, NumberFormat imaginaryFormat) Create an instance with a custom number format for the real part and a custom number format for the imaginary part. -
Method Summary
Modifier and TypeMethodDescriptionformat
(Object obj, StringBuffer toAppendTo, FieldPosition pos) Formats a object to produce a string.format
(Complex complex, StringBuffer toAppendTo, FieldPosition pos) Formats aComplex
object to produce a string.static String
This static method callsFormat.format(Object)
on a default instance of ComplexFormat.static Locale[]
Get the set of locales for which complex formats are available.Access the imaginaryCharacter.Access the imaginaryFormat.static ComplexFormat
Returns the default complex format for the current locale.static ComplexFormat
getInstance
(Locale locale) Returns the default complex format for the given locale.Access the realFormat.Parses a string to produce aComplex
object.parse
(String source, ParsePosition pos) Parses a string to produce aComplex
object.parseObject
(String source, ParsePosition pos) Parses a string to produce a object.void
setImaginaryCharacter
(String imaginaryCharacter) Modify the imaginaryCharacter.void
setImaginaryFormat
(NumberFormat imaginaryFormat) Modify the imaginaryFormat.void
setRealFormat
(NumberFormat realFormat) Modify the realFormat.Methods inherited from class org.apache.commons.math.util.CompositeFormat
formatDouble, getDefaultNumberFormat, getDefaultNumberFormat, parseAndIgnoreWhitespace, parseFixedstring, parseNextCharacter, parseNumber
Methods inherited from class java.text.Format
clone, format, formatToCharacterIterator, parseObject
-
Constructor Details
-
ComplexFormat
public ComplexFormat()Create an instance with the default imaginary character, 'i', and the default number format for both real and imaginary parts. -
ComplexFormat
Create an instance with a custom number format for both real and imaginary parts.- Parameters:
format
- the custom format for both real and imaginary parts.
-
ComplexFormat
Create an instance with a custom number format for the real part and a custom number format for the imaginary part.- Parameters:
realFormat
- the custom format for the real part.imaginaryFormat
- the custom format for the imaginary part.
-
ComplexFormat
Create an instance with a custom imaginary character, and the default number format for both real and imaginary parts.- Parameters:
imaginaryCharacter
- The custom imaginary character.
-
ComplexFormat
Create an instance with a custom imaginary character, and a custom number format for both real and imaginary parts.- Parameters:
imaginaryCharacter
- The custom imaginary character.format
- the custom format for both real and imaginary parts.
-
ComplexFormat
public ComplexFormat(String imaginaryCharacter, NumberFormat realFormat, NumberFormat imaginaryFormat) Create an instance with a custom imaginary character, a custom number format for the real part, and a custom number format for the imaginary part.- Parameters:
imaginaryCharacter
- The custom imaginary character.realFormat
- the custom format for the real part.imaginaryFormat
- the custom format for the imaginary part.
-
-
Method Details
-
getAvailableLocales
Get the set of locales for which complex formats are available.This is the same set as the
NumberFormat
set.- Returns:
- available complex format locales.
-
formatComplex
This static method callsFormat.format(Object)
on a default instance of ComplexFormat.- Parameters:
c
- Complex object to format- Returns:
- A formatted number in the form "Re(c) + Im(c)i"
-
format
Formats aComplex
object to produce a string.- Parameters:
complex
- the object to format.toAppendTo
- where the text is to be appendedpos
- On input: an alignment field, if desired. On output: the offsets of the alignment field- Returns:
- the value passed in as toAppendTo.
-
format
Formats a object to produce a string.obj
must be either aComplex
object or aNumber
object. Any other type of object will result in anIllegalArgumentException
being thrown.- Specified by:
format
in classFormat
- Parameters:
obj
- the object to format.toAppendTo
- where the text is to be appendedpos
- On input: an alignment field, if desired. On output: the offsets of the alignment field- Returns:
- the value passed in as toAppendTo.
- Throws:
IllegalArgumentException
- isobj
is not a valid type.- See Also:
-
getImaginaryCharacter
Access the imaginaryCharacter.- Returns:
- the imaginaryCharacter.
-
getImaginaryFormat
Access the imaginaryFormat.- Returns:
- the imaginaryFormat.
-
getInstance
Returns the default complex format for the current locale.- Returns:
- the default complex format.
-
getInstance
Returns the default complex format for the given locale.- Parameters:
locale
- the specific locale used by the format.- Returns:
- the complex format specific to the given locale.
-
getRealFormat
Access the realFormat.- Returns:
- the realFormat.
-
parse
Parses a string to produce aComplex
object.- Parameters:
source
- the string to parse- Returns:
- the parsed
Complex
object. - Throws:
ParseException
- if the beginning of the specified string cannot be parsed.
-
parse
Parses a string to produce aComplex
object.- Parameters:
source
- the string to parsepos
- input/ouput parsing parameter.- Returns:
- the parsed
Complex
object.
-
parseObject
Parses a string to produce a object.- Specified by:
parseObject
in classFormat
- Parameters:
source
- the string to parsepos
- input/ouput parsing parameter.- Returns:
- the parsed object.
- See Also:
-
setImaginaryCharacter
Modify the imaginaryCharacter.- Parameters:
imaginaryCharacter
- The new imaginaryCharacter value.- Throws:
IllegalArgumentException
- ifimaginaryCharacter
isnull
or an empty string.
-
setImaginaryFormat
Modify the imaginaryFormat.- Parameters:
imaginaryFormat
- The new imaginaryFormat value.- Throws:
NullArgumentException
- ifimaginaryFormat
isnull
.
-
setRealFormat
Modify the realFormat.- Parameters:
realFormat
- The new realFormat value.- Throws:
NullArgumentException
- ifrealFormat
isnull
.
-