Uses of Class
ai.rapids.cudf.Scalar

Packages that use Scalar

Package	Description
ai.rapids.cudf

Uses of Scalar in ai.rapids.cudf

Methods in ai.rapids.cudf that return Scalar

Modifier and Type	Method and Description
Scalar	ColumnView.all() Returns a boolean scalar that is true if all of the elements in the column are true or non-zero otherwise false.
Scalar	ColumnView.all(DType outType) Deprecated. the only output type supported is BOOL8.
Scalar	ColumnView.any() Returns a boolean scalar that is true if any of the elements in the column are true or non-zero otherwise false.
Scalar	ColumnView.any(DType outType) Returns a scalar is true or 1, depending on the specified type, if any of the elements in the column are true or non-zero otherwise false or 0.
static Scalar	Scalar.durationDaysFromInt(int value) Returns a DURATION_DAYS scalar
static Scalar	Scalar.durationDaysFromInt(Integer value) Returns a DURATION_DAYS scalar
static Scalar	Scalar.durationFromLong(DType type, long value) Returns a duration scalar based on the type parameter.
static Scalar	Scalar.durationFromLong(DType type, Long value) Returns a duration scalar based on the type parameter.
static Scalar	Scalar.fromBool(boolean value)
static Scalar	Scalar.fromBool(Boolean value)
static Scalar	Scalar.fromByte(byte value)
static Scalar	Scalar.fromByte(Byte value)
static Scalar	Scalar.fromDecimal(BigDecimal value)
static Scalar	Scalar.fromDecimal(BigInteger unscaledValue, DType dt)
static Scalar	Scalar.fromDecimal(int scale, BigInteger unscaledValue)
static Scalar	Scalar.fromDecimal(int scale, int unscaledValue)
static Scalar	Scalar.fromDecimal(int scale, long unscaledValue)
static Scalar	Scalar.fromDouble(double value)
static Scalar	Scalar.fromDouble(Double value)
static Scalar	Scalar.fromFloat(float value)
static Scalar	Scalar.fromFloat(Float value)
static Scalar	Scalar.fromInt(int value)
static Scalar	Scalar.fromInt(Integer value)
static Scalar	Scalar.fromLong(long value)
static Scalar	Scalar.fromLong(Long value)
static Scalar	Scalar.fromNull(DType type)
static Scalar	Scalar.fromShort(short value)
static Scalar	Scalar.fromShort(Short value)
static Scalar	Scalar.fromString(String value)
static Scalar	Scalar.fromUnsignedByte(byte value)
static Scalar	Scalar.fromUnsignedByte(Byte value)
static Scalar	Scalar.fromUnsignedInt(int value)
static Scalar	Scalar.fromUnsignedInt(Integer value)
static Scalar	Scalar.fromUnsignedLong(long value)
static Scalar	Scalar.fromUnsignedLong(Long value)
static Scalar	Scalar.fromUnsignedShort(short value)
static Scalar	Scalar.fromUnsignedShort(Short value)
static Scalar	Scalar.fromUTF8String(byte[] value) Creates a String scalar from an array of UTF8 bytes.
Scalar	ColumnView.getScalarElement(int index) Get a single item from the column at the specified index as a Scalar.
Scalar	Scalar.incRefCount() Increment the reference count for this scalar.
static Scalar	Scalar.listFromColumnView(ColumnView list) Creates a scalar of list from a ColumnView.
static Scalar	Scalar.listFromNull(HostColumnVector.DataType elementType) Creates a null scalar of list type.
Scalar	ColumnView.max() Returns the maximum of all values in the column, returning a scalar of the same type as this column.
Scalar	ColumnView.max(DType outType) Deprecated. the max reduction no longer internally allows for setting the output type, as a work around this API will cast the input type to the output type for you, but this may not work in all cases.
Scalar	ColumnView.mean() Returns the arithmetic mean of all values in the column, returning a FLOAT64 scalar unless the column type is FLOAT32 then a FLOAT32 scalar is returned.
Scalar	ColumnView.mean(DType outType) Returns the arithmetic mean of all values in the column, returning a scalar of the specified type.
Scalar	ColumnView.min() Returns the minimum of all values in the column, returning a scalar of the same type as this column.
Scalar	ColumnView.min(DType outType) Deprecated. the min reduction no longer internally allows for setting the output type, as a work around this API will cast the input type to the output type for you, but this may not work in all cases.
Scalar	ColumnView.product() Returns the product of all values in the column, returning a scalar of the same type as this column.
Scalar	ColumnView.product(DType outType) Returns the product of all values in the column, returning a scalar of the specified type.
Scalar	ColumnView.reduce(ReductionAggregation aggregation) Computes the reduction of the values in all rows of a column.
Scalar	ColumnView.reduce(ReductionAggregation aggregation, DType outType) Computes the reduction of the values in all rows of a column.
Scalar	Scalar.repeatString(int repeatTimes) Repeat the given string scalar a number of times specified by the repeatTimes parameter.
Scalar	ColumnView.standardDeviation() Returns the sample standard deviation of all values in the column, returning a FLOAT64 scalar unless the column type is FLOAT32 then a FLOAT32 scalar is returned.
Scalar	ColumnView.standardDeviation(DType outType) Returns the sample standard deviation of all values in the column, returning a scalar of the specified type.
static Scalar	Scalar.structFromColumnViews(ColumnView... columns) Creates a scalar of struct from a ColumnView.
static Scalar	Scalar.structFromNull(HostColumnVector.DataType... elementTypes) Creates a null scalar of struct type.
Scalar	ColumnView.sum() Computes the sum of all values in the column, returning a scalar of the same type as this column.
Scalar	ColumnView.sum(DType outType) Computes the sum of all values in the column, returning a scalar of the specified type.
Scalar	ColumnView.sumOfSquares() Returns the sum of squares of all values in the column, returning a scalar of the same type as this column.
Scalar	ColumnView.sumOfSquares(DType outType) Returns the sum of squares of all values in the column, returning a scalar of the specified type.
static Scalar	Scalar.timestampDaysFromInt(int value)
static Scalar	Scalar.timestampDaysFromInt(Integer value)
static Scalar	Scalar.timestampFromLong(DType type, long value)
static Scalar	Scalar.timestampFromLong(DType type, Long value)
Scalar	ColumnView.variance() Returns the variance of all values in the column, returning a FLOAT64 scalar unless the column type is FLOAT32 then a FLOAT32 scalar is returned.
Scalar	ColumnView.variance(DType outType) Returns the variance of all values in the column, returning a scalar of the specified type.

Methods in ai.rapids.cudf with parameters of type Scalar

Modifier and Type	Method and Description
ColumnVector	ColumnView.addCalendricalMonths(Scalar months) Add the specified number of months to the timestamp.
ColumnVector	ColumnView.capitalize(Scalar delimiters) Returns a column of capitalized strings.
ColumnVector	ColumnView.clamp(Scalar lo, Scalar hi) Replaces values less than `lo` in `input` with `lo`, and values greater than `hi` with `hi`.
ColumnVector	ColumnView.clamp(Scalar lo, Scalar loReplace, Scalar hi, Scalar hiReplace) Replaces values less than `lo` in `input` with `lo_replace`, and values greater than `hi` with `hi_replace`.
boolean	ColumnView.contains(Scalar needle) Find if the `needle` is present in this col example: Single Column: idx 0 1 2 3 4 col = { 10, 20, 20, 30, 50 } Scalar: value = { 20 } result = true
ColumnVector	ColumnView.endsWith(Scalar pattern) Checks if each string in a column ends with a specified comparison string, resulting in a parallel column of the boolean results.
WindowOptions.Builder	WindowOptions.Builder.following(Scalar following) Set the relative number following the current row for range window
static ColumnVector	ColumnVector.fromScalar(Scalar scalar, int rows) Create a new vector of length rows, where each row is filled with the Scalar's value
ColumnVector	ColumnView.getJSONObject(Scalar path) Apply a JSONPath string to all rows in an input strings column.
ColumnVector	ColumnView.getJSONObject(Scalar path, GetJsonObjectOptions options) Apply a JSONPath string to all rows in an input strings column.
ColumnVector	ColumnView.getMapKeyExistence(Scalar key) For a column of type List> and a passed in String key, return a boolean column for all keys in the structs, It is true if the key exists in the corresponding map for that row, false otherwise.
ColumnVector	ColumnView.getMapValue(Scalar key) Given a column of type List> and a key of type X, return a column of type Y, where each row in the output column is the Y value corresponding to the X key.
ColumnVector	ColumnView.ifElse(ColumnView trueValues, Scalar falseValue) For a BOOL8 vector, computes a vector whose rows are selected from two other inputs based on the boolean value of this vector in the corresponding row.
ColumnVector	ColumnView.ifElse(Scalar trueValue, ColumnView falseValues) For a BOOL8 vector, computes a vector whose rows are selected from two other inputs based on the boolean value of this vector in the corresponding row.
ColumnVector	ColumnView.ifElse(Scalar trueValue, Scalar falseValue) For a BOOL8 vector, computes a vector whose rows are selected from two other inputs based on the boolean value of this vector in the corresponding row.
ColumnVector	ColumnView.joinStrings(Scalar separator, Scalar narep) Concatenates all strings in the column into one new string delimited by an optional separator string.
ColumnVector	ColumnView.like(Scalar pattern, Scalar escapeChar) Returns a boolean ColumnVector identifying rows which match the given like pattern.
ColumnVector	ColumnView.listContains(Scalar key) Create a column of bool values indicating whether the specified scalar is an element of each row of a list column.
ColumnVector	ColumnView.listIndexOf(Scalar key, ColumnView.FindOptions findOption) Create a column of int32 indices, indicating the position of the scalar search key in each list row.
ColumnVector	ColumnView.lstrip(Scalar toStrip) Removes the specified characters from the beginning of each string.
WindowOptions.Builder	WindowOptions.Builder.preceding(Scalar preceding) Set the relative number preceding the current row for range window
ColumnVector	ColumnView.replaceNulls(Scalar scalar) Returns a ColumnVector with any null values replaced with a scalar.
ColumnVector	ColumnView.replaceRegex(RegexProgram regexProg, Scalar repl) For each string, replaces any character sequence matching the given regex program pattern using the replacement string scalar.
ColumnVector	ColumnView.replaceRegex(RegexProgram regexProg, Scalar repl, int maxRepl) For each string, replaces any character sequence matching the given regex program pattern using the replacement string scalar.
ColumnVector	ColumnView.replaceRegex(String pattern, Scalar repl) Deprecated.
ColumnVector	ColumnView.replaceRegex(String pattern, Scalar repl, int maxRepl) Deprecated.
ColumnVector	ColumnView.rstrip(Scalar toStrip) Removes the specified characters from the end of each string.
static Table	Table.scatter(Scalar[] source, ColumnView scatterMap, Table target) Scatters values from the source rows into the target table out-of-place, returning a new result table.
static ColumnVector	ColumnVector.sequence(Scalar initialValue, int rows) Create a new vector of length rows, starting at the initialValue and going by 1 each time.
static ColumnVector	ColumnVector.sequence(Scalar initialValue, Scalar step, int rows) Create a new vector of length rows, starting at the initialValue and going by step each time.
ColumnVector	ColumnView.startsWith(Scalar pattern) Checks if each string in a column starts with a specified comparison string, resulting in a parallel column of the boolean results.
static ColumnVector	ColumnVector.stringConcatenate(ColumnView[] columns, ColumnView sepCol, Scalar separatorNarep, Scalar colNarep, boolean separateNulls) Concatenate columns of strings together using a separator specified for each row and returns the result as a string column.
static ColumnVector	ColumnVector.stringConcatenate(Scalar separator, Scalar narep, ColumnView[] columns) Concatenate columns of strings together, combining a corresponding row from each column into a single string row of a new column.
static ColumnVector	ColumnVector.stringConcatenate(Scalar separator, Scalar narep, ColumnView[] columns, boolean separateNulls) Concatenate columns of strings together, combining a corresponding row from each column into a single string row of a new column.
ColumnVector	ColumnView.stringConcatenateListElements(ColumnView sepCol, Scalar separatorNarep, Scalar stringNarep, boolean separateNulls, boolean emptyStringOutputIfEmptyList) Given a lists column of strings (each row is a list of strings), concatenates the strings within each row and returns a single strings column result.
ColumnVector	ColumnView.stringConcatenateListElements(Scalar separator, Scalar narep, boolean separateNulls, boolean emptyStringOutputIfEmptyList) Given a lists column of strings (each row is a list of strings), concatenates the strings within each row and returns a single strings column result.
ColumnVector	ColumnView.stringContains(Scalar compString) Checks if each string in a column contains a specified comparison string, resulting in a parallel column of the boolean results.
ColumnVector	ColumnView.stringLocate(Scalar substring) Locates the starting index of the first instance of the given string in each row of a column.
ColumnVector	ColumnView.stringLocate(Scalar substring, int start) Locates the starting index of the first instance of the given string in each row of a column.
ColumnVector	ColumnView.stringLocate(Scalar substring, int start, int end) Locates the starting index of the first instance of the given string in each row of a column.
ColumnVector	ColumnView.stringReplace(Scalar target, Scalar replace) Returns a new strings column where target string within each string is replaced with the specified replacement string.
ColumnVector	ColumnView.strip(Scalar toStrip) Removes the specified characters from the beginning and end of each string.
WindowOptions.Builder	WindowOptions.Builder.window(Scalar precedingScalar, Scalar followingScalar) Set the size of the range window.