FastDoubleFormatter (OREKIT 14.0-SNAPSHOT API)

java.lang.Object
- org.orekit.utils.formatting.FastDoubleFormatter

Direct Known Subclasses:

FastDecimalFormatter, FastScientificFormatter
```
public abstract class FastDoubleFormatter
extends Object
```
Formatter for double numbers with low overhead.
This class is intended to be used when formatting large amounts of data with fixed formats like, for example, large ephemeris or measurement files.

Building the formatter is done once, and the formatter appendTo(Appendable, double) or toString(double) methods can be called hundreds of thousands of times, without incurring the overhead that would occur with String.format(). Some tests showed this formatter is about 5 times faster than String.format() with %{width}.{%precision}f format.

Instances of this class are immutable

Since:

14.0

Author:

Luc Maisonobe

Constructor Summary

Constructors
Modifier Constructor Description

protected FastDoubleFormatter(int width)
Simple constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`appendRegularValueTo(Appendable appendable, double value)`	Append one formatted value to an `Appendable`.
`void`	`appendTo(Appendable appendable, double value)`	Append one formatted value to an `Appendable`.
`int`	`getWidth()`	Get the width.
`String`	`toString(double value)`	Format one value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FastDoubleFormatter
```
protected FastDoubleFormatter(int width)
```
    Simple constructor.
    This constructor is equivalent to Formatter float format %{width}.{precision}f
    
    Parameters:
    
    width - number of characters to output
- Method Detail
  - getWidth
```
public int getWidth()
```
    Get the width.
    
    Returns:
    
    width
  - appendTo
```
public void appendTo(Appendable appendable,
                     double value)
              throws IOException
```
    Append one formatted value to an Appendable.
    
    Parameters:
    
    appendable - to append value to
    
    value - value to format
    
    Throws:
    
    IOException - if an I/O error occurs
  - appendRegularValueTo
```
protected abstract void appendRegularValueTo(Appendable appendable,
                                             double value)
                                      throws IOException
```
    Append one formatted value to an Appendable.
    
    Parameters:
    
    appendable - to append value to
    
    value - value to format
    
    Throws:
    
    IOException - if an I/O error occurs
  - toString
```
public String toString(double value)
```
    Format one value.
    
    Parameters:
    
    value - value to format
    
    Returns:
    
    formatted string