Class RealMatrixFormat
nxm
matrix in components list format
"{{a00,a01, ...,
a0m-1},{a10,
a11, ..., a1m-1},{...},{
an-10, an-11, ...,
an-1m-1}}".
The prefix and suffix "{" and "}", the row prefix and suffix "{" and "}", the row separator "," and the column 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 matrix 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: the grouping functionality of the used NumberFormat
is
disabled to prevent problems when parsing (e.g. 1,345.34 would be a valid number
but conflicts with the default column separator).
- Since:
- 3.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
Column separator.private static final String
The default column separator: ",".private static final String
The default prefix: "{".private static final String
The default row prefix: "{".private static final String
The default row separator: ",".private static final String
The default row suffix: "}".private static final String
The default suffix: "}".private final NumberFormat
The format used for components.private final String
Prefix.private final String
Row prefix.private final String
Row separator.private final String
Row suffix.private final String
Suffix. -
Constructor Summary
ConstructorsConstructorDescriptionCreate an instance with default settings.RealMatrixFormat
(String prefix, String suffix, String rowPrefix, String rowSuffix, String rowSeparator, String columnSeparator) Create an instance with custom prefix, suffix and separator.RealMatrixFormat
(String prefix, String suffix, String rowPrefix, String rowSuffix, String rowSeparator, String columnSeparator, NumberFormat format) Create an instance with custom prefix, suffix, separator and format for components.RealMatrixFormat
(NumberFormat format) Create an instance with a custom number format for components. -
Method Summary
Modifier and TypeMethodDescriptionformat
(RealMatrix m) This method callsformat(RealMatrix,StringBuffer,FieldPosition)
.format
(RealMatrix matrix, StringBuffer toAppendTo, FieldPosition pos) Formats aRealMatrix
object to produce a string.static Locale[]
Get the set of locales for which real vectors formats are available.Get the format separator between components.Get the components format.static RealMatrixFormat
Returns the default real vector format for the current locale.static RealMatrixFormat
getInstance
(Locale locale) Returns the default real vector format for the given locale.Get the format prefix.Get the format prefix.Get the format separator between rows of the matrix.Get the format suffix.Get the format suffix.Parse a string to produce aRealMatrix
object.parse
(String source, ParsePosition pos) Parse a string to produce aRealMatrix
object.
-
Field Details
-
DEFAULT_PREFIX
The default prefix: "{".- See Also:
-
DEFAULT_SUFFIX
The default suffix: "}".- See Also:
-
DEFAULT_ROW_PREFIX
The default row prefix: "{".- See Also:
-
DEFAULT_ROW_SUFFIX
The default row suffix: "}".- See Also:
-
DEFAULT_ROW_SEPARATOR
The default row separator: ",".- See Also:
-
DEFAULT_COLUMN_SEPARATOR
The default column separator: ",".- See Also:
-
prefix
Prefix. -
suffix
Suffix. -
rowPrefix
Row prefix. -
rowSuffix
Row suffix. -
rowSeparator
Row separator. -
columnSeparator
Column separator. -
format
The format used for components.
-
-
Constructor Details
-
RealMatrixFormat
public RealMatrixFormat()Create an instance with default settings.The instance uses the default prefix, suffix and row/column separator: "[", "]", ";" and ", " and the default number format for components.
-
RealMatrixFormat
Create an instance with a custom number format for components.- Parameters:
format
- the custom format for components.
-
RealMatrixFormat
public RealMatrixFormat(String prefix, String suffix, String rowPrefix, String rowSuffix, String rowSeparator, String columnSeparator) 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 "}"rowPrefix
- row prefix to use instead of the default "{"rowSuffix
- row suffix to use instead of the default "}"rowSeparator
- tow separator to use instead of the default ";"columnSeparator
- column separator to use instead of the default ", "
-
RealMatrixFormat
public RealMatrixFormat(String prefix, String suffix, String rowPrefix, String rowSuffix, String rowSeparator, String columnSeparator, 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 "}"rowPrefix
- row prefix to use instead of the default "{"rowSuffix
- row suffix to use instead of the default "}"rowSeparator
- tow separator to use instead of the default ";"columnSeparator
- column separator to use instead of the default ", "format
- the custom format for components.
-
-
Method Details
-
getAvailableLocales
Get the set of locales for which real vectors formats are available.This is the same set as the
NumberFormat
set.- Returns:
- available real vector format locales.
-
getPrefix
Get the format prefix.- Returns:
- format prefix.
-
getSuffix
Get the format suffix.- Returns:
- format suffix.
-
getRowPrefix
Get the format prefix.- Returns:
- format prefix.
-
getRowSuffix
Get the format suffix.- Returns:
- format suffix.
-
getRowSeparator
Get the format separator between rows of the matrix.- Returns:
- format separator for rows.
-
getColumnSeparator
Get the format separator between components.- Returns:
- format separator between components.
-
getFormat
Get the components format.- Returns:
- components format.
-
getInstance
Returns the default real vector format for the current locale.- Returns:
- the default real vector format.
-
getInstance
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
This method callsformat(RealMatrix,StringBuffer,FieldPosition)
.- Parameters:
m
- RealMatrix object to format.- Returns:
- a formatted matrix.
-
format
Formats aRealMatrix
object to produce a string.- Parameters:
matrix
- 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
Parse a string to produce aRealMatrix
object.- Parameters:
source
- String to parse.- Returns:
- the parsed
RealMatrix
object. - Throws:
MathParseException
- if the beginning of the specified string cannot be parsed.
-
parse
Parse a string to produce aRealMatrix
object.- Parameters:
source
- String to parse.pos
- input/ouput parsing parameter.- Returns:
- the parsed
RealMatrix
object.
-