org.bytedeco.arrow

Class Scalar

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Scalar

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BaseBinaryScalar, BaseListScalar, Decimal128Scalar, Decimal256Scalar, DictionaryScalar, ExtensionScalar, NullScalar, PrimitiveScalarBase, StructScalar, UnionScalar

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class Scalar
extends Pointer

\brief Base class for scalar values A Scalar represents a single value with a specific DataType. Scalars are useful for passing single value inputs to compute functions, or for representing individual array elements (with a non-trivial wrapping cost, though).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scalar.Hash

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.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Scalar(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	ApproxEquals(Scalar other)
boolean	ApproxEquals(Scalar other, EqualOptions options)
ScalarResult	CastTo(DataType to)
boolean	Equals(Scalar other)
boolean	Equals(Scalar other, EqualOptions options)
long	hash()
boolean	is_valid() \brief Whether the value is valid (not null) or not
Scalar	is_valid(boolean setter)
String	ToString()
DataType	type() \brief The type of the scalar value
Scalar	type(DataType setter)

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, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, 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

Scalar

public Scalar(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

type

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::DataType>"})
public DataType type()

\brief The type of the scalar value

type

public Scalar type(DataType setter)

is_valid

@Cast(value="bool")
public boolean is_valid()

\brief Whether the value is valid (not null) or not

is_valid

public Scalar is_valid(boolean setter)

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                          Scalar other,
                                          @Const @ByRef(nullValue="arrow::EqualOptions::Defaults()")
                                          EqualOptions options)

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                          Scalar other)

ApproxEquals

@Cast(value="bool")
public boolean ApproxEquals(@Const @ByRef
                                                Scalar other,
                                                @Const @ByRef(nullValue="arrow::EqualOptions::Defaults()")
                                                EqualOptions options)

ApproxEquals

@Cast(value="bool")
public boolean ApproxEquals(@Const @ByRef
                                                Scalar other)

hash

@Cast(value="size_t")
public long hash()

ToString

@StdString
public String ToString()

CastTo

@ByVal
public ScalarResult CastTo(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                  DataType to)