net.openhft.chronicle.bytes.render

Class MaximumPrecision

java.lang.Object

net.openhft.chronicle.bytes.render.MaximumPrecision

All Implemented Interfaces:

Decimaliser

public class MaximumPrecision
extends Object
implements Decimaliser

Implementation of Decimaliser that converts floating-point numbers to decimal representation with a specified maximum number of decimal places. During conversion, the number of decimal places will be limited to this maximum precision.

For example, if a maximum precision of 2 is specified, the number 1.238 will be converted to 1.24.

Constructor Summary

Constructors

Constructor and Description
MaximumPrecision(int precision) Creates a new MaximumPrecision object with the specified maximum precision.

Method Summary

Modifier and Type	Method and Description
boolean	toDecimal(double value, DecimalAppender decimalAppender) Converts a double value to its decimal representation using the specified maximum precision, and appends it to the provided DecimalAppender.
boolean	toDecimal(float value, DecimalAppender decimalAppender) Converts a float value to its decimal representation using the specified maximum precision, and appends it to the provided DecimalAppender.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaximumPrecision

public MaximumPrecision(int precision)

Creates a new MaximumPrecision object with the specified maximum precision.

Parameters:

precision - the maximum number of decimal places to be used in the conversion. Must be between 0 and 18, inclusive.

Throws:

IllegalArgumentException - if the precision is not between 0 and 18.

Method Detail

toDecimal

public boolean toDecimal(double value,
                         DecimalAppender decimalAppender)

Converts a double value to its decimal representation using the specified maximum precision, and appends it to the provided DecimalAppender.

Specified by:

toDecimal in interface Decimaliser

Parameters:

value - the double value to be converted.

decimalAppender - the DecimalAppender used to store and append the converted decimal value.

Returns:

true if the conversion and appending were successful, false if the absolute value is greater than 1e18.

Throws:

AssertionError - if the conversion fails unexpectedly.

toDecimal

public boolean toDecimal(float value,
                         DecimalAppender decimalAppender)

Converts a float value to its decimal representation using the specified maximum precision, and appends it to the provided DecimalAppender.

Specified by:

toDecimal in interface Decimaliser

Parameters:

value - the float value to be converted.

decimalAppender - the DecimalAppender used to store and append the converted decimal value.

Returns:

true if the conversion and appending were successful, false if the absolute value is greater or equal to 1e18.

Throws:

AssertionError - if the conversion fails unexpectedly.