node.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2023, 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 <cstdint>
#include <string>
 
namespace cuml {
namespace genetic {
 
struct node {
  enum class type : uint32_t {
    variable = 0,
    constant,
 
    // note: keep the case statements in alphabetical order under each category
    // of operators.
    functions_begin,
    // different binary function types follow
    binary_begin = functions_begin,
    add          = binary_begin,
    atan2,
    div,
    fdim,
    max,
    min,
    mul,
    pow,
    sub,
    binary_end = sub,  // keep this to be the last binary function in the list
    // different unary function types follow
    unary_begin,
    abs = unary_begin,
    acos,
    acosh,
    asin,
    asinh,
    atan,
    atanh,
    cbrt,
    cos,
    cosh,
    cube,
    exp,
    inv,
    log,
    neg,
    rcbrt,
    rsqrt,
    sin,
    sinh,
    sq,
    sqrt,
    tan,
    tanh,
    unary_end     = tanh,  // keep this to be the last unary function in the list
    functions_end = unary_end,
  };  // enum type
 
  explicit node();
 
  explicit node(type ft);
 
  explicit node(int fid);
 
  explicit node(float val);
 
  explicit node(const node& src);
 
  node& operator=(const node& src);
 
  bool is_terminal() const;
 
  bool is_nonterminal() const;
 
  int arity() const;
 
  static type from_str(const std::string& ntype);
 
  static const int kInvalidFeatureId;
 
  type t;
  union {
    int fid;
    float val;
  } u;
};  // struct node
 
}  // namespace genetic
}  // namespace cuml