|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math3.complex.ComplexFormat
public class ComplexFormat
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.
| Constructor Summary | |
|---|---|
ComplexFormat()
Create an instance with the default imaginary character, 'i', and the default number format for both real and imaginary parts. |
|
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. |
|
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. |
|
| Method Summary | |
|---|---|
String |
format(Complex c)
This method calls format(Object,StringBuffer,FieldPosition). |
StringBuffer |
format(Complex complex,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a Complex object to produce a string. |
String |
format(Double c)
This method calls format(Object,StringBuffer,FieldPosition). |
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a object to produce a string. |
static Locale[] |
getAvailableLocales()
Get the set of locales for which complex formats are available. |
String |
getImaginaryCharacter()
Access the imaginaryCharacter. |
NumberFormat |
getImaginaryFormat()
Access the imaginaryFormat. |
static ComplexFormat |
getInstance()
Returns the default complex format for the current locale. |
static ComplexFormat |
getInstance(Locale locale)
Returns the default complex format for the given locale. |
static ComplexFormat |
getInstance(String imaginaryCharacter,
Locale locale)
Returns the default complex format for the given locale. |
NumberFormat |
getRealFormat()
Access the realFormat. |
Complex |
parse(String source)
Parses a string to produce a Complex object. |
Complex |
parse(String source,
ParsePosition pos)
Parses a string to produce a Complex object. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ComplexFormat()
public ComplexFormat(NumberFormat format)
throws NullArgumentException
format - the custom format for both real and imaginary parts.
NullArgumentException - if realFormat is null.
public ComplexFormat(NumberFormat realFormat,
NumberFormat imaginaryFormat)
throws NullArgumentException
realFormat - the custom format for the real part.imaginaryFormat - the custom format for the imaginary part.
NullArgumentException - if imaginaryFormat is null.
NullArgumentException - if realFormat is null.
public ComplexFormat(String imaginaryCharacter)
throws NullArgumentException,
NoDataException
imaginaryCharacter - The custom imaginary character.
NullArgumentException - if imaginaryCharacter is
null.
NoDataException - if imaginaryCharacter is an
empty string.
public ComplexFormat(String imaginaryCharacter,
NumberFormat format)
throws NullArgumentException,
NoDataException
imaginaryCharacter - The custom imaginary character.format - the custom format for both real and imaginary parts.
NullArgumentException - if imaginaryCharacter is
null.
NoDataException - if imaginaryCharacter is an
empty string.
NullArgumentException - if format is null.
public ComplexFormat(String imaginaryCharacter,
NumberFormat realFormat,
NumberFormat imaginaryFormat)
throws NullArgumentException,
NoDataException
imaginaryCharacter - The custom imaginary character.realFormat - the custom format for the real part.imaginaryFormat - the custom format for the imaginary part.
NullArgumentException - if imaginaryCharacter is
null.
NoDataException - if imaginaryCharacter is an
empty string.
NullArgumentException - if imaginaryFormat is null.
NullArgumentException - if realFormat is null.| Method Detail |
|---|
public static Locale[] getAvailableLocales()
This is the same set as the NumberFormat set.
public String format(Complex c)
format(Object,StringBuffer,FieldPosition).
c - Complex object to format.
public String format(Double c)
format(Object,StringBuffer,FieldPosition).
c - Double object to format.
public StringBuffer format(Complex complex,
StringBuffer toAppendTo,
FieldPosition pos)
Complex object to produce a string.
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
public StringBuffer format(Object obj,
StringBuffer toAppendTo,
FieldPosition pos)
throws MathIllegalArgumentException
obj must be either a
Complex object or a Number object. Any other type of
object will result in an IllegalArgumentException being thrown.
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
MathIllegalArgumentException - is obj is not a valid type.Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)public String getImaginaryCharacter()
public NumberFormat getImaginaryFormat()
public static ComplexFormat getInstance()
public static ComplexFormat getInstance(Locale locale)
locale - the specific locale used by the format.
public static ComplexFormat getInstance(String imaginaryCharacter,
Locale locale)
throws NullArgumentException,
NoDataException
locale - the specific locale used by the format.imaginaryCharacter - Imaginary character.
NullArgumentException - if imaginaryCharacter is
null.
NoDataException - if imaginaryCharacter is an
empty string.public NumberFormat getRealFormat()
public Complex parse(String source)
throws MathParseException
Complex object.
source - the string to parse.
Complex object.
MathParseException - if the beginning of the specified string
cannot be parsed.
public Complex parse(String source,
ParsePosition pos)
Complex object.
source - the string to parsepos - input/ouput parsing parameter.
Complex object.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||