expression_type.hpp

Go to the documentation of this file.

// Copyright (c) Sleipnir contributors
 
#pragma once
 
#include <stdint.h>
 
#include <string_view>
 
#include "sleipnir/util/symbol_exports.hpp"
 
namespace slp {
 
/**
 * Expression type.
 *
 * Used for autodiff caching.
 */
enum class ExpressionType : uint8_t {
  /// There is no expression.
  NONE,
  /// The expression is a constant.
  CONSTANT,
  /// The expression is composed of linear and lower-order operators.
  LINEAR,
  /// The expression is composed of quadratic and lower-order operators.
  QUADRATIC,
  /// The expression is composed of nonlinear and lower-order operators.
  NONLINEAR
};
 
/**
 * Returns user-readable message corresponding to the expression type.
 *
 * @param type Expression type.
 */
SLEIPNIR_DLLEXPORT constexpr std::string_view to_message(
    const ExpressionType& type) {
  using enum ExpressionType;
 
  switch (type) {
    case NONE:
      return "none";
    case CONSTANT:
      return "constant";
    case LINEAR:
      return "linear";
    case QUADRATIC:
      return "quadratic";
    case NONLINEAR:
      return "nonlinear";
    default:
      return "unknown";
  }
}
 
}  // namespace slp