Public Member Functions | Static Public Member Functions | List of all members
cudf::window_bounds Struct Reference

Abstraction for window boundary sizes. More...

#include <rolling.hpp>

Public Member Functions

bool is_unbounded () const
 
size_type value () const
 Gets the row-boundary for this window_bounds. More...
 

Static Public Member Functions

static window_bounds get (size_type value)
 Construct bounded window boundary. More...
 
static window_bounds unbounded ()
 Construct unbounded window boundary. More...
 

Detailed Description

Abstraction for window boundary sizes.

Definition at line 97 of file rolling.hpp.

Member Function Documentation

◆ get()

static window_bounds cudf::window_bounds::get ( size_type  value)
inlinestatic

Construct bounded window boundary.

Parameters
valueFinite window boundary (in days or rows)
Returns
A window boundary

Definition at line 105 of file rolling.hpp.

◆ is_unbounded()

bool cudf::window_bounds::is_unbounded ( ) const
inline

Whether the window_bounds is unbounded.

Returns
true if the window bounds is unbounded.
false if the window bounds has a finite row boundary.

Definition at line 123 of file rolling.hpp.

◆ unbounded()

static window_bounds cudf::window_bounds::unbounded ( )
inlinestatic

Construct unbounded window boundary.

Returns
window_bounds

Definition at line 112 of file rolling.hpp.

◆ value()

size_type cudf::window_bounds::value ( ) const
inline

Gets the row-boundary for this window_bounds.

Returns
the row boundary value (in days or rows)

Definition at line 130 of file rolling.hpp.


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