arrow.rank_options

Module for [RankOptions] class

class RankOptions RankOptionsGidBuilder RankOptionsGidBuilderImpl

Types 3

classRankOptions : arrow.function_options.FunctionOptions
Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
RankOptions self() nothrowReturns `this`, for use in `with` statements.
RankOptionsGidBuilder builder() static nothrowGet builder for [arrow.rank_options.RankOptions] Returns: New builder object
arrow.types.NullPlacement nullPlacement() @property nothrowGet `nullPlacement` property. Returns: Whether nulls and NaNs are placed at the start or at the end.
void nullPlacement(arrow.types.NullPlacement propval) @property nothrowSet `nullPlacement` property. Params: propval = Whether nulls and NaNs are placed at the start or at the end.
arrow.types.RankTiebreaker tiebreaker() @property nothrowGet `tiebreaker` property. Returns: Tiebreaker for dealing with equal values in ranks.
void tiebreaker(arrow.types.RankTiebreaker propval) @property nothrowSet `tiebreaker` property. Params: propval = Tiebreaker for dealing with equal values in ranks.
void addSortKey(arrow.sort_key.SortKey sortKey) nothrowAdd a sort key to be used.
bool equal(arrow.rank_options.RankOptions otherOptions) nothrow
arrow.sort_key.SortKey[] getSortKeys() nothrow
void setSortKeys(arrow.sort_key.SortKey[] sortKeys) nothrowSet sort keys to be used.
Constructors
this(void * ptr, Flag!"Take" take)
this()
classRankOptionsGidBuilderImpl(T) : arrow.function_options.FunctionOptionsGidBuilderImpl!T

Fluent builder implementation template for arrow.rank_options.RankOptions

Methods
T nullPlacement(arrow.types.NullPlacement propval) nothrowSet `nullPlacement` property. Params: propval = Whether nulls and NaNs are placed at the start or at the end. Returns: Builder instance for fluent chaining
T tiebreaker(arrow.types.RankTiebreaker propval) nothrowSet `tiebreaker` property. Params: propval = Tiebreaker for dealing with equal values in ranks. Returns: Builder instance for fluent chaining
classRankOptionsGidBuilder : RankOptionsGidBuilderImpl!RankOptionsGidBuilder

Fluent builder for arrow.rank_options.RankOptions

Methods
RankOptions build() nothrowCreate object from builder. Returns: New object