Class Vector1DFormat
- java.lang.Object
-
- org.hipparchus.geometry.VectorFormat<Euclidean1D,Vector1D>
-
- org.hipparchus.geometry.euclidean.oned.Vector1DFormat
-
public class Vector1DFormat extends VectorFormat<Euclidean1D,Vector1D>
Formats a 1D vector in components list format "{x}".The prefix and suffix "{" and "}" 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}" and " { 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.
Note: using "," as a separator may interfere with the grouping separator of the default
NumberFormat
for the current locale. Thus it is advised to use aNumberFormat
instance with disabled grouping in such a case.
-
-
Field Summary
-
Fields inherited from class org.hipparchus.geometry.VectorFormat
DEFAULT_PREFIX, DEFAULT_SEPARATOR, DEFAULT_SUFFIX
-
-
Constructor Summary
Constructors Constructor Description Vector1DFormat()
Create an instance with default settings.Vector1DFormat(String prefix, String suffix)
Create an instance with custom prefix, suffix and separator.Vector1DFormat(String prefix, String suffix, NumberFormat format)
Create an instance with custom prefix, suffix, separator and format for components.Vector1DFormat(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 StringBuffer
format(Vector<Euclidean1D,Vector1D> vector, StringBuffer toAppendTo, FieldPosition pos)
Formats aVector
object to produce a string.static Vector1DFormat
getVector1DFormat()
Returns the default 1D vector format for the current locale.static Vector1DFormat
getVector1DFormat(Locale locale)
Returns the default 1D vector format for the given locale.Vector1D
parse(String source)
Parses a string to produce aVector
object.Vector1D
parse(String source, ParsePosition pos)
Parses a string to produce aVector
object.-
Methods inherited from class org.hipparchus.geometry.VectorFormat
format, format, getAvailableLocales, getFormat, getPrefix, getSeparator, getSuffix, parseCoordinates
-
-
-
-
Constructor Detail
-
Vector1DFormat
public Vector1DFormat()
Create an instance with default settings.The instance uses the default prefix, suffix and separator: "{", "}", and "; " and the default number format for components.
-
Vector1DFormat
public Vector1DFormat(NumberFormat format)
Create an instance with a custom number format for components.- Parameters:
format
- the custom format for components.
-
Vector1DFormat
public Vector1DFormat(String prefix, String suffix)
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 "}"
-
Vector1DFormat
public Vector1DFormat(String prefix, String suffix, 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 "}"format
- the custom format for components.
-
-
Method Detail
-
getVector1DFormat
public static Vector1DFormat getVector1DFormat()
Returns the default 1D vector format for the current locale.- Returns:
- the default 1D vector format.
- Since:
- 1.4
-
getVector1DFormat
public static Vector1DFormat getVector1DFormat(Locale locale)
Returns the default 1D vector format for the given locale.- Parameters:
locale
- the specific locale used by the format.- Returns:
- the 1D vector format specific to the given locale.
- Since:
- 1.4
-
format
public StringBuffer format(Vector<Euclidean1D,Vector1D> vector, StringBuffer toAppendTo, FieldPosition pos)
Formats aVector
object to produce a string.- Specified by:
format
in classVectorFormat<Euclidean1D,Vector1D>
- 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 Vector1D parse(String source) throws MathIllegalStateException
Parses a string to produce aVector
object.- Specified by:
parse
in classVectorFormat<Euclidean1D,Vector1D>
- Parameters:
source
- the string to parse- Returns:
- the parsed
Vector
object. - Throws:
MathIllegalStateException
- if the beginning of the specified string cannot be parsed.
-
parse
public Vector1D parse(String source, ParsePosition pos)
Parses a string to produce aVector
object.- Specified by:
parse
in classVectorFormat<Euclidean1D,Vector1D>
- Parameters:
source
- the string to parsepos
- input/output parsing parameter.- Returns:
- the parsed
Vector
object.
-
-