timemory 3.3.0
Modular C++ Toolkit for Performance Analysis and Logging. Profiling API and Tools for C, C++, CUDA, Fortran, and Python. The C++ template API is essentially a framework to creating tools: it is designed to provide a unifying interface for recording various performance measurements alongside data logging and interfaces to other tools.
measure.hpp
Go to the documentation of this file.
1// MIT License
2//
3// Copyright (c) 2020, The Regents of the University of California,
4// through Lawrence Berkeley National Laboratory (subject to receipt of any
5// required approvals from the U.S. Dept. of Energy). All rights reserved.
6//
7// Permission is hereby granted, free of charge, to any person obtaining a copy
8// of this software and associated documentation files (the "Software"), to deal
9// in the Software without restriction, including without limitation the rights
10// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11// copies of the Software, and to permit persons to whom the Software is
12// furnished to do so, subject to the following conditions:
13//
14// The above copyright notice and this permission notice shall be included in all
15// copies or substantial portions of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23// SOFTWARE.
24
25/**
26 * \file timemory/operations/types/measure.hpp
27 * \brief Definition for various functions for measure in operations
28 */
29
30#pragma once
31
35
36namespace tim
37{
38namespace operation
39{
40//
41//--------------------------------------------------------------------------------------//
42//
43///
44/// \struct tim::operation::measure
45/// \brief This operation class is used for a single measurement for a component
46///
47//
48//--------------------------------------------------------------------------------------//
49//
50template <typename Tp>
51struct measure
52{
53 using type = Tp;
54
56
57 template <typename... Args>
58 explicit measure(type& obj, Args&&... args);
59
60private:
61 // satisfies mpl condition and accepts arguments
62 template <typename Up, typename... Args>
63 auto sfinae(Up& obj, int, int, Args&&... args)
64 -> decltype(obj.measure(std::forward<Args>(args)...), void())
65 {
67 obj.measure(std::forward<Args>(args)...);
68 }
69
70 // satisfies mpl condition but does not accept arguments
71 template <typename Up, typename... Args>
72 auto sfinae(Up& obj, int, long, Args&&...) -> decltype(obj.measure(), void())
73 {
75 obj.measure();
76 }
77
78 // no member function or does not satisfy mpl condition
79 template <typename Up, typename... Args>
80 void sfinae(Up&, long, long, Args&&...)
81 {
83 }
84};
85//
86//--------------------------------------------------------------------------------------//
87//
88template <typename Tp>
89template <typename... Args>
90measure<Tp>::measure(type& obj, Args&&... args)
91{
92 sfinae(obj, 0, 0, std::forward<Args>(args)...);
93}
94//
95//--------------------------------------------------------------------------------------//
96//
97} // namespace operation
98} // namespace tim
void measure(TupleT< Tp... > &obj, Args &&... args)
Definition: functional.cpp:669
Definition: kokkosp.cpp:39
The declaration for the types for operations without definitions.
#define SFINAE_WARNING(...)
Definition: declaration.hpp:70
Include the macros for operations.
Declare the operations types.
This operation class is used for a single measurement for a component.
Definition: measure.hpp:52
TIMEMORY_DELETED_OBJECT(measure) template< typename... Args > explicit measure(type &obj