org.bytedeco.arrow

Class Decimal128

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.BasicDecimal128

org.bytedeco.arrow.Decimal128

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @Properties(inherit=arrow.class)
public class Decimal128
extends BasicDecimal128

Represents a signed 128-bit integer in two's complement. Calculations wrap around and overflow is ignored. The max decimal precision that can be safely represented is 38 significant digits. For a discussion of the algorithms, look at Knuth's volume 2, Semi-numerical Algorithms section 4.3.1. Adapted from the Apache ORC C++ implementation The implementation is split into two parts : 1. BasicDecimal128 - can be safely compiled to IR without references to libstdc++. 2. Decimal128 - has additional functionality on top of BasicDecimal128 to deal with strings and streams.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.arrow.BasicDecimal128

bit_width

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Decimal128()
Decimal128(BasicDecimal128 value) \endcond
Decimal128(byte[] bytes)
Decimal128(ByteBuffer bytes)
Decimal128(BytePointer bytes)
Decimal128(long size) Native array allocator.
Decimal128(long high, long low)
Decimal128(Pointer p) Pointer cast constructor.
Decimal128(String value) \brief Parse the number from a base 10 string representation.

Method Summary

Modifier and Type	Method and Description
long	asLong() \brief Cast this value to an int64_t.
Decimal128PairResult	Divide(Decimal128 divisor) Divide this number by right and return the result.
static Decimal128Result	FromBigEndian(byte[] data, int length)
static Decimal128Result	FromBigEndian(ByteBuffer data, int length)
static Decimal128Result	FromBigEndian(BytePointer data, int length) \brief Convert from a big-endian byte representation.
static Decimal128Result	FromReal(double real, int precision, int scale)
static Decimal128Result	FromReal(float real, int precision, int scale)
static Decimal128Result	FromString(BytePointer s)
static Status	FromString(BytePointer s, Decimal128 out, int[] precision)
static Status	FromString(BytePointer s, Decimal128 out, int[] precision, int[] scale)
static Status	FromString(BytePointer s, Decimal128 out, IntBuffer precision)
static Status	FromString(BytePointer s, Decimal128 out, IntBuffer precision, IntBuffer scale)
static Status	FromString(BytePointer s, Decimal128 out, IntPointer precision)
static Status	FromString(BytePointer s, Decimal128 out, IntPointer precision, IntPointer scale)
static Decimal128Result	FromString(String s)
static Status	FromString(String s, Decimal128 out, int[] precision)
static Status	FromString(String s, Decimal128 out, int[] precision, int[] scale)
static Status	FromString(String s, Decimal128 out, IntBuffer precision)
static Status	FromString(String s, Decimal128 out, IntBuffer precision, IntBuffer scale)
static Status	FromString(String s, Decimal128 out, IntPointer precision)
static Status	FromString(String s, Decimal128 out, IntPointer precision, IntPointer scale) \brief Convert a decimal string to a Decimal128 value, optionally including precision and scale if they're passed in and not null.
Decimal128	getPointer(long i)
Decimal128	position(long position)
Decimal128Result	Rescale(int original_scale, int new_scale) \brief Convert Decimal128 from one scale to another
double	ToDouble(int scale) \brief Convert to a floating-point number (scaled)
float	ToFloat(int scale) \brief Convert to a floating-point number (scaled)
String	ToIntegerString() \brief Convert the value to an integer string
String	ToString(int scale) \brief Convert the Decimal128 value to a base 10 decimal string with the given scale.

Methods inherited from class org.bytedeco.arrow.BasicDecimal128

Abs, Abs, addPut, andPut, bit_width, CountLeadingBinaryZeros, Divide, dividePut, FitsInPrecision, GetMaxValue, GetScaleMultiplier, GetWholeAndFraction, high_bits, IncreaseScaleBy, low_bits, multiplyPut, Negate, orPut, ReduceScaleBy, ReduceScaleBy, Rescale, shiftLeftPut, shiftRightPut, Sign, subtractPut, ToBytes, ToBytes, ToBytes, ToBytes

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Decimal128

public Decimal128(@Cast(value="int64_t")
                  long high,
                  @Cast(value="uint64_t")
                  long low)

Decimal128

public Decimal128()

Decimal128

public Decimal128(@Cast(value="const uint8_t*")
                  BytePointer bytes)

Decimal128

public Decimal128(@Cast(value="const uint8_t*")
                  ByteBuffer bytes)

Decimal128

public Decimal128(@Cast(value="const uint8_t*")
                  byte[] bytes)

Decimal128

public Decimal128(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Decimal128

public Decimal128(long size)

Native array allocator. Access with Pointer.position(long).

Decimal128

public Decimal128(@Const @ByRef
                  BasicDecimal128 value)

\endcond

\brief constructor creates a Decimal128 from a BasicDecimal128.

Decimal128

public Decimal128(@StdString
                  String value)

\brief Parse the number from a base 10 string representation.

Method Detail

position

public Decimal128 position(long position)

Overrides:

position in class BasicDecimal128

getPointer

public Decimal128 getPointer(long i)

Overrides:

getPointer in class BasicDecimal128

Divide

@ByVal
public Decimal128PairResult Divide(@Const @ByRef
                                          Decimal128 divisor)

Divide this number by right and return the result. This operation is not destructive. The answer rounds to zero. Signs work like: 21 / 5 -> 4, 1 -21 / 5 -> -4, -1 21 / -5 -> -4, 1 -21 / -5 -> 4, -1

Parameters:

divisor - [in] the number to divide by

Returns:

the pair of the quotient and the remainder

ToString

@StdString
public String ToString(int scale)

\brief Convert the Decimal128 value to a base 10 decimal string with the given scale.

ToIntegerString

@StdString
public String ToIntegerString()

\brief Convert the value to an integer string

asLong

@Cast(value="int64_t")
 @Name(value="operator int64_t")
public long asLong()

\brief Cast this value to an int64_t.

FromString

@ByVal
public static Status FromString(@StdString
                                       String s,
                                       Decimal128 out,
                                       IntPointer precision,
                                       IntPointer scale)

\brief Convert a decimal string to a Decimal128 value, optionally including precision and scale if they're passed in and not null.

FromString

@ByVal
public static Status FromString(@StdString
                                       String s,
                                       Decimal128 out,
                                       IntPointer precision)

FromString

@ByVal
public static Status FromString(@StdString
                                       BytePointer s,
                                       Decimal128 out,
                                       IntBuffer precision,
                                       IntBuffer scale)

FromString

@ByVal
public static Status FromString(@StdString
                                       BytePointer s,
                                       Decimal128 out,
                                       IntBuffer precision)

FromString

@ByVal
public static Status FromString(@StdString
                                       String s,
                                       Decimal128 out,
                                       int[] precision,
                                       int[] scale)

FromString

@ByVal
public static Status FromString(@StdString
                                       String s,
                                       Decimal128 out,
                                       int[] precision)

FromString

@ByVal
public static Status FromString(@StdString
                                       BytePointer s,
                                       Decimal128 out,
                                       IntPointer precision,
                                       IntPointer scale)

FromString

@ByVal
public static Status FromString(@StdString
                                       BytePointer s,
                                       Decimal128 out,
                                       IntPointer precision)

FromString

@ByVal
public static Status FromString(@StdString
                                       String s,
                                       Decimal128 out,
                                       IntBuffer precision,
                                       IntBuffer scale)

FromString

@ByVal
public static Status FromString(@StdString
                                       String s,
                                       Decimal128 out,
                                       IntBuffer precision)

FromString

@ByVal
public static Status FromString(@StdString
                                       BytePointer s,
                                       Decimal128 out,
                                       int[] precision,
                                       int[] scale)

FromString

@ByVal
public static Status FromString(@StdString
                                       BytePointer s,
                                       Decimal128 out,
                                       int[] precision)

FromString

@ByVal
public static Decimal128Result FromString(@StdString
                                                 String s)

FromString

@ByVal
public static Decimal128Result FromString(@StdString
                                                 BytePointer s)

FromReal

@ByVal
public static Decimal128Result FromReal(double real,
                                               int precision,
                                               int scale)

FromReal

@ByVal
public static Decimal128Result FromReal(float real,
                                               int precision,
                                               int scale)

FromBigEndian

@ByVal
public static Decimal128Result FromBigEndian(@Cast(value="const uint8_t*")
                                                    BytePointer data,
                                                    int length)

\brief Convert from a big-endian byte representation. The length must be between 1 and 16.

Returns:

error status if the length is an invalid value

FromBigEndian

@ByVal
public static Decimal128Result FromBigEndian(@Cast(value="const uint8_t*")
                                                    ByteBuffer data,
                                                    int length)

FromBigEndian

@ByVal
public static Decimal128Result FromBigEndian(@Cast(value="const uint8_t*")
                                                    byte[] data,
                                                    int length)

Rescale

@ByVal
public Decimal128Result Rescale(int original_scale,
                                       int new_scale)

\brief Convert Decimal128 from one scale to another

ToFloat

public float ToFloat(int scale)

\brief Convert to a floating-point number (scaled)

ToDouble

public double ToDouble(int scale)

\brief Convert to a floating-point number (scaled)