Public Member Functions | Public Attributes | List of all members
cudf::bounded_open Struct Reference

Strongly typed wrapper for bounded open rolling windows. More...

#include <rolling.hpp>

Public Member Functions

 bounded_open (cudf::scalar const &delta)
 Construct a bounded open rolling window. More...
 
cudf::scalar const * delta () const noexcept
 Return pointer to the row delta scalar. More...
 

Public Attributes

cudf::scalar const & delta_
 

Detailed Description

Strongly typed wrapper for bounded open rolling windows.

Parameters
deltaThe scalar delta from the current row. Must be valid, behaviour is undefined if not. If the scalar represents a floating point type the value must be neither inf nor nan, otherwise behaviour is undefined.

The endpoints of this window are excluded.

Definition at line 77 of file rolling.hpp.

Constructor & Destructor Documentation

◆ bounded_open()

cudf::bounded_open::bounded_open ( cudf::scalar const &  delta)
inline

Construct a bounded open rolling window.

Parameters
deltaThe scalar delta from the current row. Must be valid, behaviour is undefined if not.

Definition at line 87 of file rolling.hpp.

Member Function Documentation

◆ delta()

cudf::scalar const* cudf::bounded_open::delta ( ) const
inlinenoexcept

Return pointer to the row delta scalar.

Returns
pointer to scalar, not null.

Definition at line 93 of file rolling.hpp.

Member Data Documentation

◆ delta_

cudf::scalar const& cudf::bounded_open::delta_

Delta from the current row in the window. Must be valid, behaviour is undefined if not.

Definition at line 78 of file rolling.hpp.


The documentation for this struct was generated from the following file: