标量 (cudfjni 25.04.0 API)

java.lang.Object
- ai.rapids.cudf.Scalar

所有已实现的接口: BinaryOperable, AutoCloseable

public final class Scalar
extends Object
implements AutoCloseable, BinaryOperable

单个标量值。

构造器摘要

构造器
构造器和描述

Scalar(DType type, long scalarHandle)
根据本地句柄和类型创建标量的构造器。

构造器
构造器和描述
`Scalar(DType type, long scalarHandle)` 根据本地句柄和类型创建标量的构造器。

方法摘要

所有方法静态方法实例方法具体方法
修饰符和类型	方法和描述
`ColumnVector`	`binaryOp(BinaryOp op, BinaryOperable rhs, DType outType)` 多种不同的二元操作。
`void`	`close()` 释放与标量相关的内存。
`static Scalar`	`durationDaysFromInt(int value)` 返回一个 DURATION_DAYS 标量
`static Scalar`	`durationDaysFromInt(Integer value)` 返回一个 DURATION_DAYS 标量
`static Scalar`	`durationFromLong(DType type, long value)` 根据类型参数返回一个持续时间标量。
`static Scalar`	`durationFromLong(DType type, Long value)` 根据类型参数返回一个持续时间标量。
`boolean`	`equals(Object o)`
`static Scalar`	`fromBool(boolean value)`
`static Scalar`	`fromBool(Boolean value)`
`static Scalar`	`fromByte(byte value)`
`static Scalar`	`fromByte(Byte value)`
`static Scalar`	`fromDecimal(BigDecimal value)`
`static Scalar`	`fromDecimal(BigInteger unscaledValue, DType dt)`
`static Scalar`	`fromDecimal(int scale, BigInteger unscaledValue)`
`static Scalar`	`fromDecimal(int scale, int unscaledValue)`
`static Scalar`	`fromDecimal(int scale, long unscaledValue)`
`static Scalar`	`fromDouble(double value)`
`static Scalar`	`fromDouble(Double value)`
`static Scalar`	`fromFloat(float value)`
`static Scalar`	`fromFloat(Float value)`
`static Scalar`	`fromInt(int value)`
`static Scalar`	`fromInt(Integer value)`
`static Scalar`	`fromLong(long value)`
`static Scalar`	`fromLong(Long value)`
`static Scalar`	`fromNull(DType type)`
`static Scalar`	`fromShort(short value)`
`static Scalar`	`fromShort(Short value)`
`static Scalar`	`fromString(String value)`
`static Scalar`	`fromUnsignedByte(byte value)`
`static Scalar`	`fromUnsignedByte(Byte value)`
`static Scalar`	`fromUnsignedInt(int value)`
`static Scalar`	`fromUnsignedInt(Integer value)`
`static Scalar`	`fromUnsignedLong(long value)`
`static Scalar`	`fromUnsignedLong(Long value)`
`static Scalar`	`fromUnsignedShort(short value)`
`static Scalar`	`fromUnsignedShort(Short value)`
`static Scalar`	`fromUTF8String(byte[] value)` 从 UTF8 字节数组创建一个 String 标量。
`BigDecimal`	`getBigDecimal()` 将标量值作为 BigDecimal 返回。
`byte[]`	`getBigInteger()` 将 BigDecimal 非标量值作为字节数组返回。
`boolean`	`getBoolean()` 将标量值作为布尔值返回。
`byte`	`getByte()` 将标量值作为字节返回。
`ColumnView[]`	`getChildrenFromStructScalar()` 从结构体标量中获取子列的视图。
`double`	`getDouble()` 将标量值作为 double 返回。
`float`	`getFloat()` 将标量值作为 float 返回。
`int`	`getInt()` 将标量值作为 int 返回。
`String`	`getJavaString()` 将标量值作为 Java 字符串返回。
`ColumnView`	`getListAsColumnView()` 将标量值作为 ColumnView 返回。
`long`	`getLong()` 将标量值作为 long 返回。
`long`	`getScalarHandle()` 获取标量的本地句柄（本地指针地址）。
`short`	`getShort()` 将标量值作为 short 返回。
`DType`	`getType()` 获取此数据的类型。
`byte[]`	`getUTF8()` 将标量值作为 UTF-8 数据返回。
`int`	`hashCode()`
`Scalar`	`incRefCount()` 增加此标量的引用计数。
`boolean`	`isValid()`
`static Scalar`	`listFromColumnView(ColumnView list)` 从 ColumnView 创建列表标量。
`static Scalar`	`listFromNull(HostColumnVector.DataType elementType)` 创建列表类型的空标量。
`Scalar`	`repeatString(int repeatTimes)` 将给定的字符串标量重复指定次数，由 `repeatTimes` 参数指定。
`static Scalar`	`structFromColumnViews(ColumnView... columns)` 从 ColumnView 创建结构体标量。
`static Scalar`	`structFromNull(HostColumnVector.DataType... elementTypes)` 创建结构体类型的空标量。
`static Scalar`	`timestampDaysFromInt(int value)`
`static Scalar`	`timestampDaysFromInt(Integer value)`
`static Scalar`	`timestampFromLong(DType type, long value)`
`static Scalar`	`timestampFromLong(DType type, Long value)`
`String`	`toString()`

继承自类 java.lang.Object 的方法
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

继承自接口 ai.rapids.cudf.BinaryOperable 的方法
add, add, and, and, arctan2, arctan2, bitAnd, bitAnd, bitOr, bitOr, bitXor, bitXor, div, div, equalTo, equalTo, equalToNullAware, equalToNullAware, floorDiv, floorDiv, greaterOrEqualTo, greaterOrEqualTo, greaterThan, greaterThan, implicitConversion, lessOrEqualTo, lessOrEqualTo, lessThan, lessThan, log, log, maxNullAware, maxNullAware, minNullAware, minNullAware, mod, mod, mul, mul, notEqualTo, notEqualTo, notEqualToNullAware, notEqualToNullAware, or, or, pmod, pmod, pow, pow, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRightUnsigned, shiftRightUnsigned, sub, sub, trueDiv, trueDiv

- 构造器详细信息
  - Scalar
```
public Scalar(DType type,
              long scalarHandle)
```
    根据本地句柄和类型创建标量的构造器。
    
    参数
    
    type - 标量的类型
    
    scalarHandle - 标量数据的本地句柄（指针地址）
- 方法详细信息
  - fromNull
```
public static Scalar fromNull(DType type)
```
  - fromBool
```
public static Scalar fromBool(boolean value)
```
  - fromBool
```
public static Scalar fromBool(Boolean value)
```
  - fromByte
```
public static Scalar fromByte(byte value)
```
  - fromByte
```
public static Scalar fromByte(Byte value)
```
  - fromUnsignedByte
```
public static Scalar fromUnsignedByte(byte value)
```
  - fromUnsignedByte
```
public static Scalar fromUnsignedByte(Byte value)
```
  - fromShort
```
public static Scalar fromShort(short value)
```
  - fromShort
```
public static Scalar fromShort(Short value)
```
  - fromUnsignedShort
```
public static Scalar fromUnsignedShort(short value)
```
  - fromUnsignedShort
```
public static Scalar fromUnsignedShort(Short value)
```
  - durationDaysFromInt
```
public static Scalar durationDaysFromInt(int value)
```
    返回一个 DURATION_DAYS 标量
    
    参数
    
    value - - 天数
    
    返回
    
    - 标量值
  - durationDaysFromInt
```
public static Scalar durationDaysFromInt(Integer value)
```
    返回一个 DURATION_DAYS 标量
    
    参数
    
    value - - 天数
    
    返回
    
    - 标量值
  - fromInt
```
public static Scalar fromInt(int value)
```
  - fromInt
```
public static Scalar fromInt(Integer value)
```
  - fromUnsignedInt
```
public static Scalar fromUnsignedInt(int value)
```
  - fromUnsignedInt
```
public static Scalar fromUnsignedInt(Integer value)
```
  - fromLong
```
public static Scalar fromLong(long value)
```
  - fromLong
```
public static Scalar fromLong(Long value)
```
  - fromUnsignedLong
```
public static Scalar fromUnsignedLong(long value)
```
  - fromUnsignedLong
```
public static Scalar fromUnsignedLong(Long value)
```
  - fromFloat
```
public static Scalar fromFloat(float value)
```
  - fromDecimal
```
public static Scalar fromDecimal(int scale,
                                 int unscaledValue)
```
  - fromDecimal
```
public static Scalar fromDecimal(int scale,
                                 long unscaledValue)
```
  - fromDecimal
```
public static Scalar fromDecimal(int scale,
                                 BigInteger unscaledValue)
```
  - fromFloat
```
public static Scalar fromFloat(Float value)
```
  - fromDouble
```
public static Scalar fromDouble(double value)
```
  - fromDouble
```
public static Scalar fromDouble(Double value)
```
  - fromDecimal
```
public static Scalar fromDecimal(BigDecimal value)
```
  - fromDecimal
```
public static Scalar fromDecimal(BigInteger unscaledValue,
                                 DType dt)
```
  - timestampDaysFromInt
```
public static Scalar timestampDaysFromInt(int value)
```
  - timestampDaysFromInt
```
public static Scalar timestampDaysFromInt(Integer value)
```
  - durationFromLong
```
public static Scalar durationFromLong(DType type,
                                      long value)
```
    根据类型参数返回一个持续时间标量。
    
    参数
    
    type - - 要返回的标量的 dtype
    
    value - - 标量的对应值
    
    返回
    
    - 相应类型的标量
  - durationFromLong
```
public static Scalar durationFromLong(DType type,
                                      Long value)
```
    根据类型参数返回一个持续时间标量。
    
    参数
    
    type - - 要返回的标量的 dtype
    
    value - - 标量的对应值
    
    返回
    
    - 相应类型的标量
  - timestampFromLong
```
public static Scalar timestampFromLong(DType type,
                                       long value)
```
  - timestampFromLong
```
public static Scalar timestampFromLong(DType type,
                                       Long value)
```
  - fromString
```
public static Scalar fromString(String value)
```
  - fromUTF8String
```
public static Scalar fromUTF8String(byte[] value)
```
    从 UTF8 字节数组创建一个 String 标量。
    
    参数
    
    value - UTF8 字节数组
    
    返回
    
    一个 String 标量
  - listFromNull
```
public static Scalar listFromNull(HostColumnVector.DataType elementType)
```
    创建列表类型的空标量。提供此特殊 API 是因为需要元素类型来构建空的嵌套列作为列表标量的底层列。
    
    参数
    
    elementType - 列表中元素的数据类型。
    
    返回
    
    一个列表类型的空标量
  - listFromColumnView
```
public static Scalar listFromColumnView(ColumnView list)
```
    从 ColumnView 创建列表标量。ColumnView 中的所有行都将复制到 Scalar 中。因此，在此调用完成后可以关闭 ColumnView。
  - structFromNull
```
public static Scalar structFromNull(HostColumnVector.DataType... elementTypes)
```
    创建结构体类型的空标量。
    
    参数
    
    elementTypes - 结构体中子项的数据类型
    
    返回
    
    一个结构体类型的空标量
  - structFromColumnViews
```
public static Scalar structFromColumnViews(ColumnView... columns)
```
    从 ColumnView 创建结构体标量。
    
    参数
    
    columns - 结构体的子列
    
    返回
    
    一个 Struct 标量
  - getScalarHandle
```
public long getScalarHandle()
```
    获取标量的本地句柄（本地指针地址）。
    
    返回
    
    本地句柄
  - incRefCount
```
public Scalar incRefCount()
```
    增加此标量的引用计数。您需要再次调用 close 来减少引用计数。
  - close
```
public void close()
```
    释放与标量相关的内存。
    
    指定者
    
    接口 AutoCloseable 中的 close
  - getType
```
public DType getType()
```
    描述复制自接口： BinaryOperable
    
    获取此数据的类型。
    
    指定者
    
    接口 BinaryOperable 中的 getType
  - isValid
```
public boolean isValid()
```
  - getBoolean
```
public boolean getBoolean()
```
    将标量值作为布尔值返回。
  - getByte
```
public byte getByte()
```
    将标量值作为字节返回。
  - getShort
```
public short getShort()
```
    将标量值作为 short 返回。
  - getInt
```
public int getInt()
```
    将标量值作为 int 返回。
  - getLong
```
public long getLong()
```
    将标量值作为 long 返回。
  - getBigInteger
```
public byte[] getBigInteger()
```
    将 BigDecimal 非标量值作为字节数组返回。
  - getFloat
```
public float getFloat()
```
    将标量值作为 float 返回。
  - getDouble
```
public double getDouble()
```
    将标量值作为 double 返回。
  - getBigDecimal
```
public BigDecimal getBigDecimal()
```
    将标量值作为 BigDecimal 返回。
  - getJavaString
```
public String getJavaString()
```
    将标量值作为 Java 字符串返回。
  - getUTF8
```
public byte[] getUTF8()
```
    将标量值作为 UTF-8 数据返回。
  - getListAsColumnView
```
public ColumnView getListAsColumnView()
```
    将标量值作为 ColumnView 返回。调用者应关闭返回的 ColumnView 以避免内存泄漏。返回的 ColumnView 仅在 Scalar 有效时才有效。如果在 ColumnView 关闭之前关闭 Scalar，使用此 ColumnView 将导致未定义的行为。
  - getChildrenFromStructScalar
```
public ColumnView[] getChildrenFromStructScalar()
```
    从结构体标量中获取子列的视图。返回的 ColumnViews 应适当关闭。否则，将发生本地内存泄漏。
    
    返回
    
    引用结构体标量子项的列视图数组
  - binaryOp
```
public ColumnVector binaryOp(BinaryOp op,
                             BinaryOperable rhs,
                             DType outType)
```
    描述复制自接口： BinaryOperable
    
    多种不同的二元操作。
    
    指定者
    
    接口 BinaryOperable 中的 binaryOp
    
    参数
    
    op - 要执行的操作
    
    rhs - 操作的 rhs
    
    outType - 您想要的输出类型。
    
    返回
    
    结果
  - equals
```
public boolean equals(Object o)
```
    覆盖
    
    类 Object 中的 equals
  - hashCode
```
public int hashCode()
```
    覆盖
    
    类 Object 中的 hashCode
  - toString
```
public String toString()
```
    覆盖
    
    类 Object 中的 toString
  - repeatString
```
public Scalar repeatString(int repeatTimes)
```
    将给定的字符串标量重复指定次数，由 repeatTimes 参数指定。如果该参数为非正值，将返回一个空的（有效）字符串标量。无论 repeatTimes 的值如何，无效的输入标量始终会导致无效的输出标量。
    
    参数
    
    repeatTimes - 输入字符串复制到输出的次数。
    
    返回
    
    包含当前字符串重复结果的标量。

类 Scalar

构造器摘要

方法摘要

继承自类 java.lang.Object 的方法

继承自接口 ai.rapids.cudf.BinaryOperable 的方法

构造器详细信息

Scalar

方法详细信息

fromNull

fromBool

fromBool

fromByte

fromByte

fromUnsignedByte

fromUnsignedByte

fromShort

fromShort

fromUnsignedShort

fromUnsignedShort

durationDaysFromInt

durationDaysFromInt

fromInt

fromInt

fromUnsignedInt

fromUnsignedInt

fromLong

fromLong

fromUnsignedLong

fromUnsignedLong

fromFloat

fromDecimal

fromDecimal

fromDecimal

fromFloat

fromDouble

fromDouble

fromDecimal

fromDecimal

timestampDaysFromInt

timestampDaysFromInt

durationFromLong

durationFromLong

timestampFromLong

timestampFromLong

fromString

fromUTF8String

listFromNull

listFromColumnView

structFromNull

structFromColumnViews

getScalarHandle

incRefCount

close

getType

isValid

getBoolean

getByte

getShort

getInt

getLong

getBigInteger

getFloat

getDouble

getBigDecimal

getJavaString

getUTF8

getListAsColumnView

getChildrenFromStructScalar

binaryOp

equals

hashCode

toString

repeatString