org.bytedeco.arrow

Class Decimal256

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.BasicDecimal256

org.bytedeco.arrow.Decimal256

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @Properties(inherit=arrow.class)
public class Decimal256
extends BasicDecimal256

Represents a signed 256-bit integer in two's complement. The max decimal precision that can be safely represented is 76 significant digits. The implementation is split into two parts : 1. BasicDecimal256 - can be safely compiled to IR without references to libstdc++. 2. Decimal256 - (TODO) has additional functionality on top of BasicDecimal256 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.BasicDecimal256

bit_width

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Decimal256PairResult	Divide(Decimal256 divisor) Divide this number by right and return the result.
static Decimal256Result	FromBigEndian(byte[] data, int length)
static Decimal256Result	FromBigEndian(ByteBuffer data, int length)
static Decimal256Result	FromBigEndian(BytePointer data, int length) \brief Convert from a big-endian byte representation.
static Decimal256Result	FromReal(double real, int precision, int scale)
static Decimal256Result	FromReal(float real, int precision, int scale)
static Decimal256Result	FromString(BytePointer s)
static Status	FromString(BytePointer s, Decimal256 out, int[] precision)
static Status	FromString(BytePointer s, Decimal256 out, int[] precision, int[] scale)
static Status	FromString(BytePointer s, Decimal256 out, IntBuffer precision)
static Status	FromString(BytePointer s, Decimal256 out, IntBuffer precision, IntBuffer scale)
static Status	FromString(BytePointer s, Decimal256 out, IntPointer precision)
static Status	FromString(BytePointer s, Decimal256 out, IntPointer precision, IntPointer scale)
static Decimal256Result	FromString(String s)
static Status	FromString(String s, Decimal256 out, int[] precision)
static Status	FromString(String s, Decimal256 out, int[] precision, int[] scale)
static Status	FromString(String s, Decimal256 out, IntBuffer precision)
static Status	FromString(String s, Decimal256 out, IntBuffer precision, IntBuffer scale)
static Status	FromString(String s, Decimal256 out, IntPointer precision)
static Status	FromString(String s, Decimal256 out, IntPointer precision, IntPointer scale) \brief Convert a decimal string to a Decimal256 value, optionally including precision and scale if they're passed in and not null.
Decimal256	getPointer(long i)
Decimal256	position(long position)
Decimal256Result	Rescale(int original_scale, int new_scale) \brief Convert Decimal256 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 Decimal256 value to a base 10 decimal string with the given scale.

Methods inherited from class org.bytedeco.arrow.BasicDecimal256

Abs, Abs, addPut, bit_width, Divide, dividePut, FitsInPrecision, GetScaleMultiplier, IncreaseScaleBy, IsNegative, little_endian_array, low_bits, multiplyPut, Negate, ReduceScaleBy, ReduceScaleBy, Rescale, shiftLeftPut, 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

Decimal256

public Decimal256(@Const @ByRef
                  Long4Array little_endian_array)

Decimal256

public Decimal256()

Decimal256

public Decimal256(@Const @ByRef
                  BasicDecimal128 value)

Decimal256

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

Decimal256

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

Decimal256

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

Decimal256

public Decimal256(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Decimal256

public Decimal256(long size)

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

Decimal256

public Decimal256(@Const @ByRef
                  BasicDecimal256 value)

\endcond

\brief constructor creates a Decimal256 from a BasicDecimal256.

Decimal256

public Decimal256(@StdString
                  String value)

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

Method Detail

position

public Decimal256 position(long position)

Overrides:

position in class BasicDecimal256

getPointer

public Decimal256 getPointer(long i)

Overrides:

getPointer in class BasicDecimal256

ToString

@StdString
public String ToString(int scale)

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

ToIntegerString

@StdString
public String ToIntegerString()

\brief Convert the value to an integer string

FromString

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

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

FromString

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

Rescale

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

\brief Convert Decimal256 from one scale to another

Divide

@ByVal
public Decimal256PairResult Divide(@Const @ByRef
                                          Decimal256 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

FromBigEndian

@ByVal
public static Decimal256Result 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 32.

Returns:

error status if the length is an invalid value

FromBigEndian

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

FromBigEndian

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

FromReal

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

FromReal

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

ToFloat

public float ToFloat(int scale)

\brief Convert to a floating-point number (scaled). May return infinity in case of overflow.

ToDouble

public double ToDouble(int scale)

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