AlinaUtils.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* AlinaUtils.h                                                (C) 2000-2026 */
/*                                                                           */
/* Various utilities.                                                        */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_ALINA_ALINAUTILS_H
#define ARCCORE_ALINA_ALINAUTILS_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*
 * This file is based on the work on AMGCL library (version march 2026)
 * which can be found at https://github.com/ddemidov/amgcl.
 *
 * Copyright (c) 2012-2022 Denis Demidov <dennis.demidov@gmail.com>
 * SPDX-License-Identifier: MIT
 */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#pragma GCC diagnostic ignored "-Wconversion"
#pragma GCC diagnostic ignored "-Wsign-compare"
 
#include "arccore/alina/AlinaGlobal.h"
 
#include "arccore/base/Ref.h"
#include "arccore/base/FatalErrorException.h"
#include "arccore/base/ForLoopRunInfo.h"
#include "arccore/concurrency/ParallelFor.h"
 
#include <set>
#include <complex>
#include <cstddef>
#include <tuple>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::Alina
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCCORE_ALINA_EXPORT SolverResult
{
 public:
 
  SolverResult() = default;
  SolverResult(const std::tuple<size_t, double>& v)
  : m_nb_iteration(get<0>(v))
  , m_residual(get<1>(v))
  {}
  SolverResult(const std::tuple<size_t, float>& v)
  : m_nb_iteration(get<0>(v))
  , m_residual(get<1>(v))
  {}
  SolverResult(size_t nb_iteration, double residual)
  : m_nb_iteration(nb_iteration)
  , m_residual(residual)
  {}
 
  operator std::tuple<size_t, double>() const { return { m_nb_iteration, m_residual }; }
 
 public:
 
  constexpr Int32 nbIteration() const { return static_cast<Int32>(m_nb_iteration); }
  constexpr double residual() const { return m_residual; }
 
 private:
 
  size_t m_nb_iteration = 0;
  double m_residual = 0.0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace detail
{
  class PropertyWrapper;
  class ARCCORE_ALINA_EXPORT empty_params
  {
   public:
 
    empty_params() {}
 
    empty_params(const PropertyTree& ap);
    void get(PropertyTree&, const std::string&) const {}
  };
 
} // namespace detail
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// Class to wrap 'boost::property_tree::ptree' to ease removing it
class ARCCORE_ALINA_EXPORT PropertyTree
{
 public:
 
  friend detail::empty_params;
  friend detail::PropertyWrapper;
  //using BoostPTree = boost::property_tree::ptree;
 
 public:
 
  PropertyTree();
  PropertyTree(const PropertyTree& rhs);
  //explicit PropertyTree(const BoostPTree& x);
  ~PropertyTree();
 
 public:
 
  Int32 get(const char* param_type, Int32 default_value) const;
  Int64 get(const char* param_type, Int64 default_value) const;
  size_t get(const char* param_type, size_t default_value) const
  {
    return get(param_type, static_cast<Int64>(default_value));
  }
  double get(const char* param_type, double default_value) const;
  double* get(const char* param_type, double* default_value) const;
  void* get(const char* param_type, void* default_value) const;
  std::string get(const char* param_type, const std::string& default_value) const;
 
  template <typename DataType> DataType
  get(const char* param_type, const DataType& default_value) const
  requires(std::is_enum_v<DataType>)
  {
    std::ostringstream default_ostr;
    default_ostr << default_value;
    std::string s = get(param_type, default_ostr.str());
    std::istringstream istr(s);
    DataType enum_value;
    istr >> enum_value;
    if (istr.bad())
      ARCANE_FATAL("Can not convert '{0}' to enumeration", s);
    return enum_value;
  }
 
  void put(const std::string& path, Int32 value);
  void put(const std::string& path, Int64 value);
  void put(const std::string& path, size_t value)
  {
    put(path, static_cast<Int64>(value));
  }
 
  void put(const std::string& path, double value);
  void put(const std::string& path, const std::string& value);
  void put(const std::string& path, double* value);
  void put(const std::string& path, void* value);
 
  template <typename DataType> void
  put(const std::string& path, const DataType& value)
  requires(std::is_enum_v<DataType>)
  {
    // Convert enum to string.
    std::ostringstream ostr;
    ostr << value;
    put(path, ostr.str());
  }
 
  // Put parameter in form "key=value" into a boost::property_tree::ptree
  void putKeyValue(const std::string& param);
 
  PropertyTree get_child_empty(const std::string& path) const;
  bool erase(const char* name);
  size_t count(const char* name) const;
 
  // NOTE: Does not seems to be used.
  void _addChild(const std::string& path, const char* name, const PropertyTree& obj);
 
 public:
 
  void read_json(const std::string& filename);
 
 public:
 
  void check_params(const std::set<std::string>& names) const;
  void check_params(const std::set<std::string>& names, const std::set<std::string>& opt_names) const;
  ARCCORE_ALINA_EXPORT friend std::ostream& operator<<(std::ostream& o, const PropertyTree& obj);
 
 private:
 
  void* m_property_tree = nullptr;
  bool m_is_own = false;
};
 
} // namespace Arcane::Alina
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/alina/ScopedStreamModifier.h"

#ifdef ARCCORE_ALINA_PROFILING
#if !defined(ARCCORE_ALINA_TIC) || !defined(ARCCORE_ALINA_TOC)
#include "arccore/alina/Profiler.h"
#define ARCCORE_ALINA_TIC(name) ::Arcane::Alina::Profiler::globalTic(name);
#define ARCCORE_ALINA_TOC(name) ::Arcane::Alina::Profiler::globalToc(name);
#endif
#endif
 
#ifndef ARCCORE_ALINA_TIC
#define ARCCORE_ALINA_TIC(name)
#endif
#ifndef ARCCORE_ALINA_TOC
#define ARCCORE_ALINA_TOC(name)
#endif
 
#define ARCCORE_ALINA_DEBUG_SHOW(x) \
  std::cout << std::setw(20) << #x << ": " \
            << std::setw(15) << std::setprecision(8) << std::scientific \
            << (x) << std::endl
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::Alina
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class Condition, class Message>
void precondition(const Condition& condition, const Message& message)
{
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4800)
#endif
  if (!condition)
    throw std::runtime_error(message);
#ifdef _MSC_VER
#pragma warning(pop)
#endif
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#define ARCCORE_ALINA_PARAMS_IMPORT_VALUE(p, name) \
  name(p.get(#name, params().name))
 
#define ARCCORE_ALINA_PARAMS_IMPORT_CHILD(p, name) \
  name(p.get_child_empty(#name))
 
#define ARCCORE_ALINA_PARAMS_EXPORT_VALUE(p, path, name) \
  p.put(std::string(path) + #name, name)
 
namespace detail
{
 
  template <typename T>
  inline void params_export_child(PropertyTree& ap,
                                  const std::string& path,
                                  const char* name, const T& obj)
  {
    obj.get(ap, std::string(path) + name + ".");
  }
 
  // NOTE GG: This method is not used in the tests.
  template <>
  inline void params_export_child(PropertyTree& ap,
                                  const std::string& path, const char* name,
                                  const PropertyTree& obj)
  {
    ap._addChild(path, name, obj);
  }
 
} // namespace detail
 
#define ARCCORE_ALINA_PARAMS_EXPORT_CHILD(p, path, name) \
  ::Arcane::Alina::detail::params_export_child(p, path, #name, name)
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// Missing parameter action
#ifndef ARCCORE_ALINA_PARAM_MISSING
#define ARCCORE_ALINA_PARAM_MISSING(name) (void)0
#endif
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// N-dimensional dense matrix
template <class T, int N>
class multi_array
{
  static_assert(N > 0, "Wrong number of dimensions");
 
 public:
 
  template <class... I>
  multi_array(I... n)
  {
    static_assert(sizeof...(I) == N, "Wrong number of dimensions");
    buf.resize(init(n...));
  }
 
  size_t size() const
  {
    return buf.size();
  }
 
  int stride(int i) const
  {
    return strides[i];
  }
 
  template <class... I>
  T operator()(I... i) const
  {
    static_assert(sizeof...(I) == N, "Wrong number of indices");
    return buf[index(i...)];
  }
 
  template <class... I>
  T& operator()(I... i)
  {
    static_assert(sizeof...(I) == N, "Wrong number of indices");
    return buf[index(i...)];
  }
 
  const T* data() const
  {
    return buf.data();
  }
 
  T* data()
  {
    return buf.data();
  }
 
 private:
 
  std::array<int, N> strides;
  std::vector<T> buf;
 
  template <class... I>
  int index(int i, I... tail) const
  {
    return strides[N - sizeof...(I) - 1] * i + index(tail...);
  }
 
  int index(int i) const
  {
    return strides[N - 1] * i;
  }
 
  template <class... I>
  int init(int i, I... tail)
  {
    int size = init(tail...);
    strides[N - sizeof...(I) - 1] = size;
    return i * size;
  }
 
  int init(int i)
  {
    strides[N - 1] = 1;
    return i;
  }
};
 
template <class T>
class circular_buffer
{
 public:
 
  circular_buffer(size_t n)
  : start(0)
  {
    buf.reserve(n);
  }
 
  size_t size() const
  {
    return buf.size();
  }
 
  void push_back(const T& v)
  {
    if (buf.size() < buf.capacity()) {
      buf.push_back(v);
    }
    else {
      buf[start] = v;
      start = (start + 1) % buf.capacity();
    }
  }
 
  const T& operator[](size_t i) const
  {
    return buf[(start + i) % buf.capacity()];
  }
 
  T& operator[](size_t i)
  {
    return buf[(start + i) % buf.capacity()];
  }
 
  void clear()
  {
    buf.clear();
    start = 0;
  }
 
 private:
 
  size_t start;
  std::vector<T> buf;
};
 
namespace detail
{
 
  template <class T>
  T eps(size_t n)
  {
    return 2 * std::numeric_limits<T>::epsilon() * n;
  }
 
} // namespace detail
 
template <class T> struct is_complex : std::false_type
{};
template <class T> struct is_complex<std::complex<T>> : std::true_type
{};
 
inline std::string human_readable_memory(size_t bytes)
{
  static const char* suffix[] = { "B", "K", "M", "G", "T" };
 
  int i = 0;
  double m = static_cast<double>(bytes);
  for (; i < 4 && m >= 1024.0; ++i, m /= 1024.0)
    ;
 
  std::ostringstream s;
  s << std::fixed << std::setprecision(2) << m << " " << suffix[i];
  return s.str();
}
 
namespace detail
{
 
  class non_copyable
  {
   protected:
 
    non_copyable() = default;
    ~non_copyable() = default;
 
    non_copyable(non_copyable const&) = delete;
    void operator=(non_copyable const& x) = delete;
  };

  template <typename Col, typename Val>
  void sort_row(Col* col, Val* val, int n)
  {
    for (int j = 1; j < n; ++j) {
      Col c = col[j];
      Val v = val[j];
 
      int i = j - 1;
 
      while (i >= 0 && col[i] > c) {
        col[i + 1] = col[i];
        val[i + 1] = val[i];
        i--;
      }
 
      col[i + 1] = c;
      val[i + 1] = v;
    }
  }
 
} // namespace detail
 
namespace error
{
 
  struct empty_level
  {};
 
} // namespace error
} // namespace Arcane::Alina
 
namespace std
{
 
// Read pointers from input streams.
// This allows exchanging pointers through boost::property_tree::ptree.
template <class T>
inline istream& operator>>(istream& is, T*& ptr)
{
  Arcane::Alina::ScopedStreamModifier ss(is);
 
  size_t val;
  is >> std::hex >> val;
 
  ptr = reinterpret_cast<T*>(val);
 
  return is;
}
 
} // namespace std
 
#endif