concepts.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_CONCEPTS_H
#define GUM_CONCEPTS_H
 
#include <concepts>
#include <limits>
 
#include <type_traits>
 
namespace gum {


  template < typename T >
  concept GUM_HasNumericLimits = requires {
    { std::numeric_limits< T >::min() } -> std::convertible_to< T >;
    { std::numeric_limits< T >::max() } -> std::convertible_to< T >;
    { std::numeric_limits< T >::infinity() } -> std::convertible_to< T >;
    { std::numeric_limits< T >::is_specialized } -> std::convertible_to< bool >;
  };

  template < typename T >
  concept GUM_IsGumScalar
      = std::is_arithmetic_v< T >
     || (
            // Custom numeric type requirements:
 
            // Must be copyable and movable
            std::copyable< T > && std::movable< T > &&
 
            // Must be default constructible (for containers)
            std::default_initializable< T > &&
 
            // Must be constructible from common numeric literals
            std::constructible_from< T, int > && std::constructible_from< T, double > &&
 
            // Must support all arithmetic operations
            requires(T a, T b) {
              { a + b } -> std::convertible_to< T >;
              { a - b } -> std::convertible_to< T >;
              { a * b } -> std::convertible_to< T >;
              { a / b } -> std::convertible_to< T >;
              { a += b } -> std::same_as< T& >;
              { a *= b } -> std::same_as< T& >;
              { -a } -> std::convertible_to< T >;   // unary minus
            } &&
 
            // Must be totally ordered (supports <, >, <=, >=, ==, !=)
            std::totally_ordered< T >);

  template < typename T >
  concept GUM_Numeric = GUM_IsGumScalar< T > && GUM_HasNumericLimits< T >;

 
}   // namespace gum
 
#endif   // GUM_CONCEPTS_H