range_window_bounds.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2024, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <cudf/scalar/scalar.hpp>
#include <cudf/utilities/export.hpp>
 
namespace CUDF_EXPORT cudf {
struct range_window_bounds {
 public:
  enum class extent_type : int32_t {
    CURRENT_ROW = 0,  
    BOUNDED,          
    UNBOUNDED         
  };
 
  static range_window_bounds get(scalar const& boundary,
                                 rmm::cuda_stream_view stream = cudf::get_default_stream());
 
  static range_window_bounds current_row(data_type type,
                                         rmm::cuda_stream_view stream = cudf::get_default_stream());
 
  [[nodiscard]] bool is_current_row() const { return _extent == extent_type::CURRENT_ROW; }
 
  static range_window_bounds unbounded(data_type type,
                                       rmm::cuda_stream_view stream = cudf::get_default_stream());
 
  [[nodiscard]] bool is_unbounded() const { return _extent == extent_type::UNBOUNDED; }
 
  [[nodiscard]] scalar const& range_scalar() const { return *_range_scalar; }
 
  range_window_bounds(range_window_bounds const&) = default;  
  range_window_bounds() = default;  // Required for use as return types from dispatch functors.
 
 private:
  extent_type _extent{extent_type::UNBOUNDED};
  std::shared_ptr<scalar> _range_scalar{nullptr};  // To enable copy construction/assignment.
 
  range_window_bounds(extent_type extent_,
                      std::unique_ptr<scalar> range_scalar_,
                      rmm::cuda_stream_view = cudf::get_default_stream());
};
  // end of group
}  // namespace CUDF_EXPORT cudf