types.hpp

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2020, The Regents of the University of California,
// through Lawrence Berkeley National Laboratory (subject to receipt of any
// required approvals from the U.S. Dept. of Energy).  All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// 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.
 
/**
 * \file timemory/components/base/types.hpp
 * \brief Declare the base component types
 */
 
#pragma once
 
#include "timemory/components/macros.hpp"
#include "timemory/mpl/concepts.hpp"
#include "timemory/mpl/math.hpp"
#include "timemory/mpl/quirks.hpp"
#include "timemory/utility/types.hpp"
 
#include <type_traits>
 
//======================================================================================//
//
namespace tim
{
namespace trait
{
template <typename Tp>
struct data;
 
template <typename Tp>
using data_t = typename data<Tp>::type;
}  // namespace trait
 
namespace component
{
//
// generic static polymorphic base class
template <typename Tp,
          typename ValueType = conditional_t<concepts::is_empty<trait::data_t<Tp>>::value,
                                             int64_t, trait::data_t<Tp>>>
struct base;
//
//--------------------------------------------------------------------------------------//
//
namespace operators
{
//
//--------------------------------------------------------------------------------------//
//
//         the operator- is used very, very often in stop() of components
//
//--------------------------------------------------------------------------------------//
//
template <typename Tp>
Tp
operator-(Tp lhs, const Tp& rhs)
{
    math::minus(lhs, rhs);
    return lhs;
}
//
//--------------------------------------------------------------------------------------//
//
}  // namespace operators
//
//--------------------------------------------------------------------------------------//
//
struct empty_base;
//
struct empty_storage;
//
struct dynamic_base;
//
template <typename Tp, typename Value>
struct base;
//
//--------------------------------------------------------------------------------------//
//
template <typename Tp>
struct base<Tp, void>;
//
//--------------------------------------------------------------------------------------//
//
}  // namespace component
//
//----------------------------------------------------------------------------------//
//
namespace trait
{
/// \struct tim::trait::dynamic_base
/// \brief trait that designates the type the static polymorphic base class
/// (\ref tim::component::base) inherit from.
///
template <typename Tp>
struct dynamic_base : std::false_type
{
    using type = component::empty_base;
};
//
}  // namespace trait
//
//----------------------------------------------------------------------------------//
//
}  // namespace tim
//
//======================================================================================//
 
namespace tim
{
namespace cereal
{
namespace detail
{
template <typename Tp, typename Vp>
struct StaticVersion<tim::component::base<Tp, Vp>>
{
    static constexpr uint32_t version = 0;
};
}  // namespace detail
}  // namespace cereal
}  // namespace tim