domain_function.hpp

Go to the documentation of this file.

// --------------------------------------------------------------------------
//
// Copyright (C) 2025-present by Pablo Antolin
//
// This file is part of the QUGaR library.
//
// SPDX-License-Identifier:    MIT
//
// --------------------------------------------------------------------------
 
#ifndef QUGAR_IMPL_DOMAIN_FUNCTION_HPP
#define QUGAR_IMPL_DOMAIN_FUNCTION_HPP

 
#include <qugar/types.hpp>
 
#include <qugar/point.hpp>
#include <qugar/vector.hpp>
 
#include <algoim/interval.hpp>
 
#include <cstdint>
#include <type_traits>
 
namespace qugar::impl {
 
enum FuncSign : std::int8_t { negative, positive, undetermined };

template<int dim, int range> class DomainFunc
{
public:
  template<int N> using Interval = ::algoim::Interval<N>;

  template<typename T> using Value = std::conditional_t<range == 1, T, Vector<T, range>>;

  template<typename T> using Gradient = Vector<Value<T>, dim>;

  static const int num_hessian = dim * (dim + 1) / 2;

  template<typename T> using Hessian = Vector<Value<T>, num_hessian>;

  DomainFunc() = default;
  DomainFunc(const DomainFunc &) = default;
  DomainFunc(DomainFunc &&) = default;
  DomainFunc &operator=(const DomainFunc &) = default;
  DomainFunc &operator=(DomainFunc &&) = default;
  virtual ~DomainFunc() = default;

  [[nodiscard]] virtual Value<real> operator()(const Point<dim> &point) const = 0;

  [[nodiscard]] virtual Value<Interval<dim>> operator()(const Point<dim, Interval<dim>> &point) const = 0;

  [[nodiscard]] virtual Gradient<real> grad(const Point<dim> &point) const = 0;

  [[nodiscard]] virtual Gradient<Interval<dim>> grad(const Point<dim, Interval<dim>> &point) const = 0;

  [[nodiscard]] virtual Hessian<real> hessian(const Point<dim> &point) const = 0;
};

template<int dim> using ScalarFunc = DomainFunc<dim, 1>;

template<int dim> using ImplicitFunc = ScalarFunc<dim>;
 
}// namespace qugar::impl
 
 
#endif// QUGAR_IMPL_DOMAIN_FUNCTION_HPP