binaryop.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2019-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/column/column.hpp>
#include <cudf/scalar/scalar.hpp>
#include <cudf/utilities/export.hpp>
 
#include <rmm/mr/device/per_device_resource.hpp>
#include <rmm/resource_ref.hpp>
 
#include <memory>
 
namespace CUDF_EXPORT cudf {
 
enum class binary_operator : int32_t {
  ADD,          
  SUB,          
  MUL,          
  DIV,          
  TRUE_DIV,     
  FLOOR_DIV,    
  MOD,          
  PMOD,         
  PYMOD,        
  POW,          
  INT_POW,      
  LOG_BASE,     
  ATAN2,        
  SHIFT_LEFT,   
  SHIFT_RIGHT,  
  SHIFT_RIGHT_UNSIGNED,  
  BITWISE_AND,           
  BITWISE_OR,            
  BITWISE_XOR,           
  LOGICAL_AND,           
  LOGICAL_OR,            
  EQUAL,                 
  NOT_EQUAL,             
  LESS,                  
  GREATER,               
  LESS_EQUAL,            
  GREATER_EQUAL,         
  NULL_EQUALS,           
  NULL_NOT_EQUALS,       
  NULL_MAX,              
  NULL_MIN,              
  GENERIC_BINARY,        
  NULL_LOGICAL_AND,  
  NULL_LOGICAL_OR,   
  INVALID_BINARY     
};
 
template <typename L, typename R, typename = void>
struct binary_op_common_type {};
 
template <typename L, typename R>
struct binary_op_common_type<L, R, std::enable_if_t<has_common_type_v<L, R>>> {
  using type = std::common_type_t<L, R>;
};
 
template <typename L, typename R>
struct binary_op_common_type<
  L,
  R,
  std::enable_if_t<is_fixed_point<L>() && cuda::std::is_floating_point_v<R>>> {
  using type = L;
};
 
template <typename L, typename R>
struct binary_op_common_type<
  L,
  R,
  std::enable_if_t<is_fixed_point<R>() && cuda::std::is_floating_point_v<L>>> {
  using type = R;
};
 
template <typename L, typename R>
using binary_op_common_type_t = typename binary_op_common_type<L, R>::type;
 
namespace detail {
template <typename AlwaysVoid, typename L, typename R>
struct binary_op_has_common_type_impl : std::false_type {};
 
template <typename L, typename R>
struct binary_op_has_common_type_impl<std::void_t<binary_op_common_type_t<L, R>>, L, R>
  : std::true_type {};
}  // namespace detail
 
template <typename L, typename R>
constexpr inline bool binary_op_has_common_type_v =
  detail::binary_op_has_common_type_impl<void, L, R>::value;
 
std::unique_ptr<column> binary_operation(
  scalar const& lhs,
  column_view const& rhs,
  binary_operator op,
  data_type output_type,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> binary_operation(
  column_view const& lhs,
  scalar const& rhs,
  binary_operator op,
  data_type output_type,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> binary_operation(
  column_view const& lhs,
  column_view const& rhs,
  binary_operator op,
  data_type output_type,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
 
std::unique_ptr<column> binary_operation(
  column_view const& lhs,
  column_view const& rhs,
  std::string const& ptx,
  data_type output_type,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
 
int32_t binary_operation_fixed_point_scale(binary_operator op,
                                           int32_t left_scale,
                                           int32_t right_scale);
 
cudf::data_type binary_operation_fixed_point_output_type(binary_operator op,
                                                         cudf::data_type const& lhs,
                                                         cudf::data_type const& rhs);
 
namespace binops {
 
bool is_supported_operation(data_type out, data_type lhs, data_type rhs, binary_operator op);
 
std::pair<rmm::device_buffer, size_type> scalar_col_valid_mask_and(
  column_view const& col,
  scalar const& s,
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
 
}  // namespace binops
  // end of group
}  // namespace CUDF_EXPORT cudf
 
namespace CUDF_EXPORT cudf {
namespace binops::compiled::detail {
 
void apply_sorting_struct_binary_op(mutable_column_view& out,
                                    column_view const& lhs,
                                    column_view const& rhs,
                                    bool is_lhs_scalar,
                                    bool is_rhs_scalar,
                                    binary_operator op,
                                    rmm::cuda_stream_view stream);
}  // namespace binops::compiled::detail
}  // namespace CUDF_EXPORT cudf