Showing content from http://umontreal-simul.github.io/ssj/docs/master/classumontreal_1_1ssj_1_1util_1_1PrintfFormat.html below:
SSJ: PrintfFormat Class Reference
This class acts like a StringBuffer which defines new types of append
methods. More...
PrintfFormat () Constructs a new buffer object containing an empty string.
PrintfFormat (int length) Constructs a new buffer object with an initial capacity of length
. More...
PrintfFormat (String str) Constructs a new buffer object containing the initial string str
. More...
PrintfFormat append (String str) Appends str
to the buffer. More...
PrintfFormat append (int fieldwidth, String str) Uses the s(int,String) static method to append str
to the buffer. More...
PrintfFormat append (double x) Appends x
to the buffer. More...
PrintfFormat append (int fieldwidth, double x) Uses the f(int,double) static method to append x
to the buffer. More...
PrintfFormat append (int fieldwidth, int precision, double x) Uses the f(int,int,double) static method to append x
to the buffer. More...
PrintfFormat append (int x) Appends x
to the buffer. More...
PrintfFormat append (int fieldwidth, int x) Uses the d(int,long) static method to append x
to the buffer. More...
PrintfFormat append (long x) Appends x
to the buffer. More...
PrintfFormat append (int fieldwidth, long x) Uses the d(int,long) static method to append x
to the buffer. More...
PrintfFormat append (int fieldwidth, int accuracy, int precision, double x) Uses the format(int,int,int,double) static method with the same four arguments to append x
to the buffer. More...
PrintfFormat append (char c) Appends a single character to the buffer. More...
void clear () Clears the contents of the buffer.
StringBuffer getBuffer () Returns the StringBuffer associated with that object. More...
String toString () Converts the buffer into a String. More...
static String s (String str) Same as s(0, str). More...
static String s (int fieldwidth, String str) Formats the string str
like the s
in the C printf
function. More...
static String d (long x) Same as d(0, 1, x). More...
static String d (int fieldwidth, long x) Same as d(fieldwidth, 1, x). More...
static String d (int fieldwidth, int precision, long x) Formats the long integer x
into a string like d
in the C printf
function. More...
static String format (long x) Same as d(0, 1, x). More...
static String format (int fieldwidth, long x) Converts a long integer to a String with a minimum length of fieldwidth
, the result is right-padded with spaces if necessary but it is not truncated. More...
static String formatBase (int b, long x) Same as formatBase(0, b, x). More...
static String formatBase (int fieldwidth, int b, long x) Converts the integer x
to a String representation in base b
. More...
static void formatWithError (int fieldwidth, int fieldwidtherr, int accuracy, int precision, double x, double error, String[] res) Stores a string containing x
into res[0]
, and a string containing error
into res[1]
, both strings being formatted with the same notation. More...
static void formatWithError (int fieldwidth, int fieldwidtherr, int precision, double x, double error, String[] res) Stores a string containing x
into res[0]
, and a string containing error
into res[1]
, both strings being formatted with the same notation. More...
static void formatWithError (Locale locale, int fieldwidth, int fieldwidtherr, int accuracy, int precision, double x, double error, String[] res) This method is equivalent to #formatWithError(int,int,int,double,double,String[]), except that it formats the given value and error for the locale locale
. More...
static void formatWithError (Locale locale, int fieldwidth, int fieldwidtherr, int precision, double x, double error, String[] res) This method is equivalent to #formatWithError(int,int,int,double,double,String[]), except that it formats the given value and error for the locale locale
. More...
char charAt (int index) int length () CharSequence subSequence (int start, int end) Appendable append (CharSequence csq) Appendable append (CharSequence csq, int start, int end) static String E (double x) Same as E(0, 6, x). More...
static String E (int fieldwidth, double x) Same as E(fieldwidth, 6, x). More...
static String E (int fieldwidth, int precision, double x) Formats a double-precision number x
like E
in C printf
. More...
static String e (double x) Same as e(0, 6, x). More...
static String e (int fieldwidth, double x) Same as e(fieldwidth, 6, x). More...
static String e (int fieldwidth, int precision, double x) The same as E
, except that ‘e’
is used as the exponent character instead of ‘E’
. More...
static String f (double x) Same as f(0, 6, x). More...
static String f (int fieldwidth, double x) Same as f(fieldwidth, 6, x). More...
static String f (int fieldwidth, int precision, double x) Formats the double-precision x
into a string like f
in C printf
. More...
static String G (double x) Same as G(0, 6, x). More...
static String G (int fieldwidth, double x) Same as G(fieldwidth, 6, x). More...
static String G (int fieldwidth, int precision, double x) Formats the double-precision x
into a string like G
in C printf
. More...
static String g (double x) Same as g(0, 6, x). More...
static String g (int fieldwidth, double x) Same as g(fieldwidth, 6, x). More...
static String g (int fieldwidth, int precision, double x) The same as G
, except that ‘e’
is used in the scientific notation. More...
static String format (int fieldwidth, int accuracy, int precision, double x) Returns a String containing x
. More...
static String format (Locale locale, int fieldwidth, int accuracy, int precision, double x) This method is equivalent to format(int,int,int,double), except it formats the given value for the locale locale
. More...
static String formatBase (int fieldwidth, int accuracy, int b, double x) Converts \(x\) to a String representation in base \(b\) using formatting similar to the \(f\) methods. More...
This class acts like a StringBuffer which defines new types of append
methods.
It defines certain functionalities of the ANSI C printf
function that also can be accessed through static methods. The information given here is strongly inspired from the man
page of the C printf
function.
Most methods of this class format numbers for the English US locale only. One can use the Java class Formatter for performing locale-independent formatting.
◆ PrintfFormat() [1/2]
Constructs a new buffer object with an initial capacity of length
.
-
Parameters
-
length initial length of the buffer
◆ PrintfFormat() [2/2]
Constructs a new buffer object containing the initial string str
.
-
Parameters
-
str initial contents of the buffer
◆ append() [1/11]
Appends str
to the buffer.
-
Parameters
-
str string to append to the buffer
-
Returns
-
this object
◆ append() [2/11]
Uses the s(int,String) static method to append str
to the buffer.
A minimum of fieldwidth
characters will be used.
-
Parameters
-
fieldwidth minimum number of characters that will be added to the buffer str string to append to the buffer
-
Returns
-
this object
◆ append() [3/11]
Appends x
to the buffer.
-
Parameters
-
x value being added to the buffer
-
Returns
-
this object
◆ append() [4/11]
Uses the f(int,double) static method to append x
to the buffer.
A minimum of fieldwidth
characters will be used.
-
Parameters
-
fieldwidth minimum length of the converted string to be appended x value to be appended to the buffer
-
Returns
-
this object
◆ append() [5/11] PrintfFormat append ( int fieldwidth, int precision, double x )
Uses the f(int,int,double) static method to append x
to the buffer.
A minimum of fieldwidth
characters will be used with the given precision
.
-
Parameters
-
fieldwidth minimum length of the converted string to be appended precision number of digits after the decimal point of the converted value x value to be appended to the buffer
-
Returns
-
this object
◆ append() [6/11]
Appends x
to the buffer.
-
Parameters
-
x value to be appended to the buffer
-
Returns
-
this object
◆ append() [7/11]
Uses the d(int,long) static method to append x
to the buffer.
A minimum of fieldwidth
characters will be used.
-
Parameters
-
fieldwidth minimum length of the converted string to be appended x value to be appended to the buffer
-
Returns
-
this object
◆ append() [8/11]
Appends x
to the buffer.
-
Parameters
-
x value to be appended to the buffer
-
Returns
-
this object
◆ append() [9/11]
Uses the d(int,long) static method to append x
to the buffer.
A minimum of fieldwidth
characters will be used.
-
Parameters
-
fieldwidth minimum length of the converted string to be appended x value to be appended to the buffer
-
Returns
-
this object
◆ append() [10/11] PrintfFormat append ( int fieldwidth, int accuracy, int precision, double x )
Uses the format(int,int,int,double) static method with the same four arguments to append x
to the buffer.
-
Parameters
-
fieldwidth minimum length of the converted string to be appended accuracy number of digits after the decimal point precision number of significant digits x value to be appended to the buffer
-
Returns
-
this object
◆ append() [11/11]
Appends a single character to the buffer.
-
Parameters
-
c character to be appended to the buffer
-
Returns
-
this object
◆ d() [1/3] static String d ( long x ) static
Same as d(0, 1, x).
-
Parameters
-
-
Returns
-
the same string, padded with spaces or zeros if appropriate
◆ d() [2/3] static String d ( int fieldwidth, long x ) static
Same as d(fieldwidth, 1, x).
-
Parameters
-
fieldwidth minimum length of the returned string x the string to process
-
Returns
-
the same string, padded with spaces or zeros if appropriate
◆ d() [3/3] static String d ( int fieldwidth, int precision, long x ) static
Formats the long integer x
into a string like d
in the C printf
function.
It converts its argument to decimal notation, precision
gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros. When zero is printed with an explicit precision 0, the output is empty.
-
Parameters
-
fieldwidth minimum length of the returned string precision number of digits in the returned string x the string to process
-
Returns
-
the same string, padded with spaces or zeros if appropriate
◆ E() [1/3] static String E ( double x ) static
Same as E(0, 6, x).
-
Parameters
-
x the value to be converted to string
-
Returns
-
the converted value as a string
◆ E() [2/3] static String E ( int fieldwidth, double x ) static
Same as E(fieldwidth, 6, x).
-
Parameters
-
fieldwidth minimum length of the returned string x the value to be converted to string
-
Returns
-
the converted value as a string
◆ E() [3/3] static String E ( int fieldwidth, int precision, double x ) static
Formats a double-precision number x
like E
in C printf
.
The double argument is rounded and converted in the style [-]d.dddE+-dd
where there is one digit before the decimal-point character and the number of digits after it is equal to the precision; if the precision is 0, no decimal-point character appears. The exponent always contains at least two digits; if the value is zero, the exponent is 00
.
-
Parameters
-
fieldwidth minimum length of the returned string precision number of digits after the decimal point x the value to be converted to string
-
Returns
-
the converted value as a string
◆ e() [1/3] static String e ( double x ) static
Same as e(0, 6, x).
-
Parameters
-
x the value to be converted to string
-
Returns
-
the converted value as a string
◆ e() [2/3] static String e ( int fieldwidth, double x ) static
Same as e(fieldwidth, 6, x).
-
Parameters
-
fieldwidth minimum length of the returned string x the value to be converted to string
-
Returns
-
the converted value as a string
◆ e() [3/3] static String e ( int fieldwidth, int precision, double x ) static
The same as E
, except that ‘e’
is used as the exponent character instead of ‘E’
.
-
Parameters
-
fieldwidth minimum length of the returned string precision number of digits after the decimal point x the value to be converted to string
-
Returns
-
the converted value as a string
◆ f() [1/3] static String f ( double x ) static
Same as f(0, 6, x).
-
Parameters
-
x the value to be converted to string
-
Returns
-
the converted value as a string
◆ f() [2/3] static String f ( int fieldwidth, double x ) static
Same as f(fieldwidth, 6, x).
-
Parameters
-
fieldwidth minimum length of the returned string x the value to be converted to string
-
Returns
-
the converted value as a string
◆ f() [3/3] static String f ( int fieldwidth, int precision, double x ) static
Formats the double-precision x
into a string like f
in C printf
.
The argument is rounded and converted to decimal notation in the style [-]ddd.ddd
, where the number of digits after the decimal-point character is equal to the precision specification. If the precision is explicitly 0, no decimal-point character appears. If a decimal point appears, at least one digit appears before it.
-
Parameters
-
fieldwidth minimum length of the returned string precision number of digits after the decimal point x the value to be converted to string
-
Returns
-
the converted value as a string
◆ format() [1/4] static String format ( long x ) static
Same as d(0, 1, x).
-
Parameters
-
x the value to be processed
-
Returns
-
the string resulting from the conversion
◆ format() [2/4] static String format ( int fieldwidth, long x ) static
Converts a long integer to a String with a minimum length of fieldwidth
, the result is right-padded with spaces if necessary but it is not truncated.
If only one argument is specified, a fieldwidth
of 0 is assumed.
-
Parameters
-
fieldwidth minimum length of the returned string x the value to be processed
-
Returns
-
the string resulting from the conversion
◆ format() [3/4] static String format ( int fieldwidth, int accuracy, int precision, double x ) static
Returns a String containing x
.
Uses a total of at least fieldwidth
positions (including the sign and point when they appear), accuracy
digits after the decimal point and at least precision
significant digits. accuracy
and precision
must be strictly smaller than fieldwidth
. The number is rounded if necessary. If there is not enough space to format the number in decimal notation with at least precision
significant digits (accuracy
or fieldwidth
is too small), it will be converted to scientific notation with at least precision
significant digits. In that case, fieldwidth
is increased if necessary.
-
Parameters
-
fieldwidth minimum length of the returned string accuracy number of digits after the decimal point precision number of significant digits x the value to be processed
-
Returns
-
the converted value as a string
◆ format() [4/4] static String format ( Locale locale, int fieldwidth, int accuracy, int precision, double x ) static
This method is equivalent to format(int,int,int,double), except it formats the given value for the locale locale
.
-
Parameters
-
locale the locale being used for formatting fieldwidth minimum length of the returned string accuracy number of digits after the decimal point precision number of significant digits x the value to be processed
-
Returns
-
the converted value as a string
◆ formatBase() [1/3] static String formatBase ( int b, long x ) static
Same as formatBase(0, b, x).
-
Parameters
-
b the base used for conversion x the value to be processed
-
Returns
-
a string representing
x
in base b
◆ formatBase() [2/3] static String formatBase ( int fieldwidth, int b, long x ) static
Converts the integer x
to a String representation in base b
.
Restrictions: \(2\le\) b
\(\le10\).
-
Parameters
-
fieldwidth minimum length of the returned string b the base used for conversion x the value to be processed
-
Returns
-
a string representing
x
in base b
◆ formatBase() [3/3] static String formatBase ( int fieldwidth, int accuracy, int b, double x ) static
Converts \(x\) to a String representation in base \(b\) using formatting similar to the \(f\) methods.
Uses a total of at least fieldwidth
positions (including the sign and point when they appear) and accuracy
digits after the decimal point. If fieldwidth
is negative, the number is printed left-justified, otherwise right-justified. Restrictions: \(2 \le b \le10\) and \(|x| < 2^{63}\).
-
Parameters
-
fieldwidth minimum length of the returned string accuracy number of digits after the decimal point b base x the value to be processed
-
Returns
-
the converted value as a string
◆ formatWithError() [1/4] static void formatWithError ( int fieldwidth, int fieldwidtherr, int accuracy, int precision, double x, double error, String [] res ) static
Stores a string containing x
into res[0]
, and a string containing error
into res[1]
, both strings being formatted with the same notation.
Uses a total of at least fieldwidth
positions (including the sign and point when they appear) for x
, fieldwidtherr
positions for error
, accuracy
digits after the decimal point and at least precision
significant digits. accuracy
and precision
must be strictly smaller than fieldwidth
. The numbers are rounded if necessary. If there is not enough space to format x
in decimal notation with at least precision
significant digits (accuracy
or fieldwidth
are too small), it will be converted to scientific notation with at least precision
significant digits. In that case, fieldwidth
is increased if necessary, and the error is also formatted in scientific notation.
-
Parameters
-
fieldwidth minimum length of the value string fieldwidtherr minimum length of the error string accuracy number of digits after the decimal point for the value and error precision number of significant digits for the value x the value to be processed error the error on the value to be processed res an array that will be filled with the formatted value and formatted error
◆ formatWithError() [2/4] static void formatWithError ( int fieldwidth, int fieldwidtherr, int precision, double x, double error, String [] res ) static
Stores a string containing x
into res[0]
, and a string containing error
into res[1]
, both strings being formatted with the same notation.
This calls #formatWithError(int,int,int,int,double,double,String[]) with the minimal accuracy for which the formatted string for error
is non-zero. If error
is 0, the accuracy is 0. If this minimal accuracy causes the strings to be formatted using scientific notation, this method increases the accuracy until the decimal notation can be used.
-
Parameters
-
fieldwidth minimum length of the value string fieldwidtherr minimum length of the error string precision number of significant digits for the value x the value to be processed error the error on the value to be processed res an array that will be filled with the formatted value and formatted error
◆ formatWithError() [3/4] static void formatWithError ( Locale locale, int fieldwidth, int fieldwidtherr, int accuracy, int precision, double x, double error, String [] res ) static
This method is equivalent to #formatWithError(int,int,int,double,double,String[]), except that it formats the given value and error for the locale locale
.
-
Parameters
-
locale the locale being used fieldwidth minimum length of the value string fieldwidtherr minimum length of the error string accuracy number of digits after the decimal point for the value and error precision number of significant digits for the value x the value to be processed error the error on the value to be processed res an array that will be filled with the formatted value and formatted error
◆ formatWithError() [4/4] static void formatWithError ( Locale locale, int fieldwidth, int fieldwidtherr, int precision, double x, double error, String [] res ) static
This method is equivalent to #formatWithError(int,int,int,double,double,String[]), except that it formats the given value and error for the locale locale
.
-
Parameters
-
locale the locale being used fieldwidth minimum length of the value string fieldwidtherr minimum length of the error string precision number of significant digits for the value x the value to be processed error the error on the value to be processed res an array that will be filled with the formatted value and formatted error
◆ G() [1/3] static String G ( double x ) static
Same as G(0, 6, x).
-
Parameters
-
x the value to be converted to string
-
Returns
-
the converted value as a string
◆ G() [2/3] static String G ( int fieldwidth, double x ) static
Same as G(fieldwidth, 6, x).
-
Parameters
-
fieldwidth minimum length of the returned string x the value to be converted to string
-
Returns
-
the converted value as a string
◆ G() [3/3] static String G ( int fieldwidth, int precision, double x ) static
Formats the double-precision x
into a string like G
in C printf
.
The argument is converted in style f
or E
. precision
specifies the number of significant digits. If it is 0, it is treated as 1. Style E
is used if the exponent from its conversion is less than \(-4\) or greater than or equal to precision
. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if it is followed by at least one digit.
-
Parameters
-
fieldwidth minimum length of the returned string precision number of significant digits x the value to be converted to string
-
Returns
-
the converted value as a string
◆ g() [1/3] static String g ( double x ) static
Same as g(0, 6, x).
-
Parameters
-
x the value to be converted to string
-
Returns
-
the converted value as a string
◆ g() [2/3] static String g ( int fieldwidth, double x ) static
Same as g(fieldwidth, 6, x).
-
Parameters
-
fieldwidth minimum length of the returned string x the value to be converted to string
-
Returns
-
the converted value as a string
◆ g() [3/3] static String g ( int fieldwidth, int precision, double x ) static
The same as G
, except that ‘e’
is used in the scientific notation.
-
Parameters
-
fieldwidth minimum length of the returned string precision number of significant digits x the value to be converted to string
-
Returns
-
the converted value as a string
◆ getBuffer() StringBuffer getBuffer ( )
Returns the StringBuffer associated with that object.
-
Returns
-
the internal StringBuffer object
◆ s() [1/2] static String s ( String str ) static
Same as s(0, str).
If the string str
is null, it returns the string "null".
-
Parameters
-
str the string to process
-
Returns
-
the same string
◆ s() [2/2] static String s ( int fieldwidth, String str ) static
Formats the string str
like the s
in the C printf
function.
The fieldwidth
argument gives the minimum length of the resulting string. If str
is shorter than fieldwidth
, it is left-padded with spaces. If fieldwidth
is negative, the string is right-padded with spaces if necessary. The String will never be truncated. If str
is null, it calls s(fieldwidth, "null"). The fieldwidth
argument has the same effect for the other methods in this class.
-
Parameters
-
fieldwidth minimum length of the returned string str the string to process
-
Returns
-
the same string padded with spaces if necessary
◆ toString()
Converts the buffer into a String.
-
Returns
-
the String conversion of the internal buffer
◆ LINE_SEPARATOR final String LINE_SEPARATOR static Initial value:
=
System.getProperty("line.separator")
End-of-line symbol or line separator.
Same as NEWLINE
.
◆ NEWLINE Initial value:
=
System.getProperty("line.separator")
End-of-line symbol or line separator.
It is "\\n" for Unix/Linux, "\\r\\n" for MS-DOS/MS-Windows, and "\\r" for Apple OSX.
The documentation for this class was generated from the following file:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4