Class RealVectorFormat
- java.lang.Object
-
- org.apache.commons.math4.legacy.linear.RealVectorFormat
-
public class RealVectorFormat extends Object
Formats a vector in components list format "{v0; v1; ...; vk-1}".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.
- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description RealVectorFormat()Create an instance with default settings.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.RealVectorFormat(NumberFormat format)Create an instance with a custom number format for components.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringformat(RealVector v)This method callsformat(RealVector,StringBuffer,FieldPosition).StringBufferformat(RealVector vector, StringBuffer toAppendTo, FieldPosition pos)Formats aRealVectorobject to produce a string.static Locale[]getAvailableLocales()Get the set of locales for which real vectors formats are available.NumberFormatgetFormat()Get the components format.static RealVectorFormatgetInstance()Returns the default real vector format for the current locale.static RealVectorFormatgetInstance(Locale locale)Returns the default real vector format for the given locale.StringgetPrefix()Get the format prefix.StringgetSeparator()Get the format separator between components.StringgetSuffix()Get the format suffix.ArrayRealVectorparse(String source)Parse a string to produce aRealVectorobject.ArrayRealVectorparse(String source, ParsePosition pos)Parse a string to produce aRealVectorobject.
-
-
-
Constructor Detail
-
RealVectorFormat
public RealVectorFormat()
Create an instance with default settings.The instance uses the default prefix, suffix and separator: "{", "}", and "; " and the default number format for components.
-
RealVectorFormat
public RealVectorFormat(NumberFormat format)
Create an instance with a custom number format for components.- Parameters:
format- the custom format for components.
-
RealVectorFormat
public RealVectorFormat(String prefix, String suffix, String separator)
Create an instance with custom prefix, suffix and separator.- Parameters:
prefix- prefix to use instead of the default "{"suffix- suffix to use instead of the default "}"separator- separator to use instead of the default "; "
-
RealVectorFormat
public RealVectorFormat(String prefix, String suffix, String separator, NumberFormat format)
Create an instance with custom prefix, suffix, separator and format for components.- Parameters:
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.
-
-
Method Detail
-
getAvailableLocales
public static Locale[] getAvailableLocales()
Get the set of locales for which real vectors formats are available.This is the same set as the
NumberFormatset.- Returns:
- available real vector format locales.
-
getSeparator
public String getSeparator()
Get the format separator between components.- Returns:
- format separator.
-
getFormat
public NumberFormat getFormat()
Get the components format.- Returns:
- components format.
-
getInstance
public static RealVectorFormat getInstance()
Returns the default real vector format for the current locale.- Returns:
- the default real vector format.
-
getInstance
public static RealVectorFormat getInstance(Locale locale)
Returns the default real vector format for the given locale.- Parameters:
locale- the specific locale used by the format.- Returns:
- the real vector format specific to the given locale.
-
format
public String format(RealVector v)
This method callsformat(RealVector,StringBuffer,FieldPosition).- Parameters:
v- RealVector object to format.- Returns:
- a formatted vector.
-
format
public StringBuffer format(RealVector vector, StringBuffer toAppendTo, FieldPosition pos)
Formats aRealVectorobject to produce a string.- Parameters:
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 field- Returns:
- the value passed in as toAppendTo.
-
parse
public ArrayRealVector parse(String source)
Parse a string to produce aRealVectorobject.- Parameters:
source- String to parse.- Returns:
- the parsed
RealVectorobject. - Throws:
MathParseException- if the beginning of the specified string cannot be parsed.
-
parse
public ArrayRealVector parse(String source, ParsePosition pos)
Parse a string to produce aRealVectorobject.- Parameters:
source- String to parse.pos- input/output parsing parameter.- Returns:
- the parsed
RealVectorobject.
-
-