org.apache.commons.math.linear
public class RealVectorFormat extends CompositeFormat
The prefix and suffix "{" and "}" and the separator "; " can be replaced by any user-defined strings. The number format for components can be configured.
White space is ignored at parse time, even if it is in the prefix, suffix or separator specifications. So even if the default separator does include a space character that is used at format time, both input string "{1;1;1}" and " { 1 ; 1 ; 1 } " will be parsed without error and the same vector will be returned. In the second case, however, the parse position after parsing will be just after the closing curly brace, i.e. just before the trailing space.
Format.Field
Modifier and Type | Field and Description |
---|---|
private static String |
DEFAULT_PREFIX
The default prefix: "{".
|
private static String |
DEFAULT_SEPARATOR
The default separator: ", ".
|
private static String |
DEFAULT_SUFFIX
The default suffix: "}".
|
private NumberFormat |
format
The format used for components.
|
private String |
prefix
Prefix.
|
private String |
separator
Separator.
|
private static long |
serialVersionUID
Serializable version identifier
|
private String |
suffix
Suffix.
|
private String |
trimmedPrefix
Trimmed prefix.
|
private String |
trimmedSeparator
Trimmed separator.
|
private String |
trimmedSuffix
Trimmed suffix.
|
Constructor and Description |
---|
RealVectorFormat()
Create an instance with default settings.
|
RealVectorFormat(NumberFormat format)
Create an instance with a custom number format for components.
|
RealVectorFormat(String prefix,
String suffix,
String separator)
Create an instance with custom prefix, suffix and separator.
|
RealVectorFormat(String prefix,
String suffix,
String separator,
NumberFormat format)
Create an instance with custom prefix, suffix, separator and format
for components.
|
Modifier and Type | Method and Description |
---|---|
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a object to produce a string.
|
StringBuffer |
format(RealVector vector,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a
RealVector object to produce a string. |
static String |
formatRealVector(RealVector v)
This static method calls
Format.format(Object) on a default instance of
RealVectorFormat. |
static Locale[] |
getAvailableLocales()
Get the set of locales for which real vectors formats are available.
|
NumberFormat |
getFormat()
Get the components format.
|
static RealVectorFormat |
getInstance()
Returns the default real vector format for the current locale.
|
static RealVectorFormat |
getInstance(Locale locale)
Returns the default real vector format for the given locale.
|
String |
getPrefix()
Get the format prefix.
|
String |
getSeparator()
Get the format separator between components.
|
String |
getSuffix()
Get the format suffix.
|
ArrayRealVector |
parse(String source)
Parses a string to produce a
RealVector object. |
ArrayRealVector |
parse(String source,
ParsePosition pos)
Parses a string to produce a
RealVector object. |
Object |
parseObject(String source,
ParsePosition pos)
Parses a string to produce a object.
|
formatDouble, getDefaultNumberFormat, getDefaultNumberFormat, parseAndIgnoreWhitespace, parseFixedstring, parseNextCharacter, parseNumber
clone, format, formatToCharacterIterator, parseObject
private static final long serialVersionUID
private static final String DEFAULT_PREFIX
private static final String DEFAULT_SUFFIX
private static final String DEFAULT_SEPARATOR
private final String prefix
private final String suffix
private final String separator
private final String trimmedPrefix
private final String trimmedSuffix
private final String trimmedSeparator
private final NumberFormat format
public RealVectorFormat()
The instance uses the default prefix, suffix and separator: "{", "}", and "; " and the default number format for components.
public RealVectorFormat(NumberFormat format)
format
- the custom format for components.public RealVectorFormat(String prefix, String suffix, String separator)
prefix
- prefix to use instead of the default "{"suffix
- suffix to use instead of the default "}"separator
- separator to use instead of the default "; "public RealVectorFormat(String prefix, String suffix, String separator, NumberFormat format)
prefix
- prefix to use instead of the default "{"suffix
- suffix to use instead of the default "}"separator
- separator to use instead of the default "; "format
- the custom format for components.public static Locale[] getAvailableLocales()
This is the same set as the NumberFormat
set.
public String getPrefix()
public String getSuffix()
public String getSeparator()
public NumberFormat getFormat()
public static RealVectorFormat getInstance()
public static RealVectorFormat getInstance(Locale locale)
locale
- the specific locale used by the format.public static String formatRealVector(RealVector v)
Format.format(Object)
on a default instance of
RealVectorFormat.v
- RealVector object to formatpublic StringBuffer format(RealVector vector, StringBuffer toAppendTo, FieldPosition pos)
RealVector
object to produce a string.vector
- 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 fieldpublic StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
obj
must be a RealVector
object. Any other type of
object will result in an IllegalArgumentException
being thrown.
format
in class Format
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 fieldIllegalArgumentException
- is obj
is not a valid type.Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
public ArrayRealVector parse(String source) throws ParseException
RealVector
object.source
- the string to parseRealVector
object.ParseException
- if the beginning of the specified string
cannot be parsed.public ArrayRealVector parse(String source, ParsePosition pos)
RealVector
object.source
- the string to parsepos
- input/ouput parsing parameter.RealVector
object.public Object parseObject(String source, ParsePosition pos)
parseObject
in class Format
source
- the string to parsepos
- input/ouput parsing parameter.Format.parseObject(java.lang.String, java.text.ParsePosition)
Copyright (c) 2003-2013 Apache Software Foundation