I/O counter for chars written. The number of bytes which this task has caused, or shall cause to be written to disk. Similar caveats apply here as with tim::component::read_char (rchar). More...

#include "timemory/components/io/components.hpp"

Collaboration diagram for tim::component::written_char:

Public Types
using	this_type = written_char

using	value_type = std::array< int64_t, 2 >

using	base_type = base< this_type, value_type >

using	result_type = std::array< double, 2 >

using	unit_type = typename trait::units< this_type >::type

using	display_unit_type = typename trait::units< this_type >::display_type

using	storage_type = empty_storage

Public Member Functions
std::string	get_display () const

result_type	get () const

void	start ()

void	stop ()

void	sample ()
	sample a measurement More...

void	sample (const cache_type &_cache)
	sample a measurement from cached data More...

void	start (const cache_type &_cache)
	start a measurement using the cached data More...

void	stop (const cache_type &_cache)
	stop a measurement using the cached data More...

Static Public Member Functions
static std::string	label ()

static std::string	description ()

static result_type	unit ()

static std::vector< std::string >	display_unit_array ()

static std::vector< std::string >	label_array ()

static display_unit_type	display_unit ()

static std::array< double, 2 >	unit_array ()

static std::vector< std::string >	description_array ()

static auto	get_timestamp ()

static value_type	record ()

static auto	get_timing_unit ()

static unit_type	get_unit ()

static display_unit_type	get_display_unit ()

static value_type	record (const cache_type &_cache)
	read the value from cached data More...

template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

I/O counter for chars written. The number of bytes which this task has caused, or shall cause to be written to disk. Similar caveats apply here as with tim::component::read_char (rchar).

Definition at line 258 of file components.hpp.

Member Typedef Documentation

◆ base_type

using tim::component::written_char::base_type = base<this_type, value_type>

Definition at line 262 of file components.hpp.

◆ display_unit_type

using tim::component::written_char::display_unit_type = typename trait::units<this_type>::display_type

Definition at line 265 of file components.hpp.

◆ result_type

using tim::component::written_char::result_type = std::array<double, 2>

Definition at line 263 of file components.hpp.

◆ storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

◆ this_type

using tim::component::written_char::this_type = written_char

Definition at line 260 of file components.hpp.

◆ unit_type

using tim::component::written_char::unit_type = typename trait::units<this_type>::type

Definition at line 264 of file components.hpp.

◆ value_type

using tim::component::written_char::value_type = std::array<int64_t, 2>

Definition at line 261 of file components.hpp.

Member Function Documentation

◆ description()

static std::string tim::component::written_char::description ( )

inlinestatic

Definition at line 268 of file components.hpp.

    {
        return "Number of bytes which this task has caused, or shall cause to be written "
               "to disk. Similar caveats to read_char.";
    }

◆ description_array()

static std::vector< std::string > tim::component::written_char::description_array ( )

inlinestatic

Definition at line 298 of file components.hpp.

    {
        return std::vector<std::string>{ "Number of char written",
                                         "Rate of char written" };
    }

◆ display_unit()

static display_unit_type tim::component::written_char::display_unit ( )

inlinestatic

Definition at line 291 of file components.hpp.

    {
        return display_unit_type{ { "MB", "MB/sec" } };
    }

Referenced by get_display_unit().

◆ display_unit_array()

static std::vector< std::string > tim::component::written_char::display_unit_array ( )

inlinestatic

Definition at line 280 of file components.hpp.

    {
        return std::vector<std::string>{ std::get<0>(get_display_unit()),
                                         std::get<1>(get_display_unit()) };
    }

References get_display_unit().

◆ get()

result_type tim::component::written_char::get ( ) const

inline

Definition at line 346 of file components.hpp.

    {
        auto val = base_type::load();
 
        double data  = std::get<0>(val);
        double delta = std::get<1>(val);
 
        delta /= static_cast<double>(std::nano::den);
        delta *= get_timing_unit();
 
        double rate = 0.0;
        if(delta != 0.0)
            rate = data / delta;
 
        if(laps > 0)
            rate *= laps;
 
        data /= std::get<0>(get_unit());
        rate /= std::get<0>(get_unit());
 
        if(!std::isfinite(rate))
            rate = 0.0;
 
        return result_type{ { data, rate } };
    }

References get_timing_unit(), get_unit(), tim::isfinite(), tim::component::base< written_char, std::array< int64_t, 2 > >::laps, and tim::component::base< Tp, Value >::load().

Referenced by get_display().

◆ get_display()

std::string tim::component::written_char::get_display ( ) const

inline

Definition at line 319 of file components.hpp.

    {
        std::stringstream ss;
        std::stringstream ssv;
        std::stringstream ssr;
        auto              _prec  = base_type::get_precision();
        auto              _width = base_type::get_width();
        auto              _flags = base_type::get_format_flags();
        auto              _disp  = get_display_unit();
 
        auto _val = get();
 
        ssv.setf(_flags);
        ssv << std::setw(_width) << std::setprecision(_prec) << std::get<0>(_val);
        if(!std::get<0>(_disp).empty())
            ssv << " " << std::get<0>(_disp);
 
        ssr.setf(_flags);
        ssr << std::setw(_width) << std::setprecision(_prec) << std::get<1>(_val);
        if(!std::get<1>(_disp).empty())
            ssr << " " << std::get<1>(_disp);
 
        ss << ssv.str() << ", " << ssr.str();
        ss << " wchar";
        return ss.str();
    }

References get(), get_display_unit(), tim::component::base< Tp, Value >::get_format_flags(), tim::component::base< Tp, Value >::get_precision(), and tim::component::base< Tp, Value >::get_width().

◆ get_display_unit()

static display_unit_type tim::component::written_char::get_display_unit ( )

inlinestatic

Definition at line 405 of file components.hpp.

    {
        static display_unit_type _instance = this_type::display_unit();
        static auto&             _mem      = std::get<0>(_instance);
        static auto&             _rate     = std::get<1>(_instance);
 
        if(settings::memory_units().length() > 0)
            _mem = std::get<0>(units::get_memory_unit(settings::memory_units()));
 
        if(settings::timing_units().length() > 0)
        {
            auto _tval = std::get<0>(units::get_timing_unit(settings::timing_units()));
            _rate      = mpl::apply<std::string>::join('/', _mem, _tval);
        }
        else if(settings::memory_units().length() > 0)
        {
            _rate = mpl::apply<std::string>::join('/', _mem, "sec");
        }
 
        return _instance;
    }

References display_unit(), tim::units::get_memory_unit(), tim::units::get_timing_unit(), tim::mpl::apply< Ret >::join(), tim::memory_units, and tim::timing_units.

Referenced by display_unit_array(), and get_display().

◆ get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args && ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

◆ get_timestamp()

static auto tim::component::written_char::get_timestamp ( )

inlinestatic

Definition at line 304 of file components.hpp.

304{ return tim::get_clock_real_now<int64_t, std::nano>(); }

Referenced by record().

◆ get_timing_unit()

static auto tim::component::written_char::get_timing_unit ( )

inlinestatic

Definition at line 311 of file components.hpp.

    {
        static auto _value = units::sec;
        if(settings::timing_units().length() > 0)
            _value = std::get<1>(units::get_timing_unit(settings::timing_units()));
        return _value;
    }

References tim::units::get_timing_unit(), and tim::timing_units.

Referenced by get().

◆ get_unit()

static unit_type tim::component::written_char::get_unit ( )

inlinestatic

Definition at line 382 of file components.hpp.

    {
        static auto  _instance = this_type::unit();
        static auto& _mem      = std::get<0>(_instance);
        static auto& _rate     = std::get<1>(_instance);
 
        if(settings::memory_units().length() > 0)
            _mem = std::get<1>(units::get_memory_unit(settings::memory_units()));
 
        if(settings::timing_units().length() > 0)
        {
            auto _timing_val =
                std::get<1>(units::get_timing_unit(settings::timing_units()));
            _rate = _mem / (_timing_val);
        }
 
        static const auto factor = static_cast<double>(std::nano::den);
        unit_type         _tmp   = _instance;
        std::get<1>(_tmp) *= factor;
 
        return _tmp;
    }

References tim::units::get_memory_unit(), tim::units::get_timing_unit(), tim::memory_units, tim::timing_units, and unit().

Referenced by get().

◆ label()

static std::string tim::component::written_char::label ( )

inlinestatic

Definition at line 267 of file components.hpp.

267{ return "written_char"; }

Referenced by label_array().

◆ label_array()

static std::vector< std::string > tim::component::written_char::label_array ( )

inlinestatic

Definition at line 286 of file components.hpp.

    {
        return std::vector<std::string>{ label(), "written_rate" };
    }

References label().

◆ record() [1/2]

static value_type tim::component::written_char::record ( )

inlinestatic

Definition at line 306 of file components.hpp.

    {
        return value_type{ { get_char_written(), get_timestamp() } };
    }

References get_timestamp().

Referenced by start(), and stop().

◆ record() [2/2]

static value_type tim::component::written_char::record ( const cache_type & _cache )

inlinestatic

read the value from cached data

Definition at line 442 of file components.hpp.

    {
        return value_type{ { _cache.get_char_written(), get_timestamp() } };
    }

References get_timestamp().

◆ sample() [1/2]

void tim::component::written_char::sample ( )

inline

sample a measurement

Definition at line 428 of file components.hpp.

    {
        std::get<0>(accum) = std::get<0>(value) =
            std::max<int64_t>(std::get<0>(value), get_char_written());
    }

◆ sample() [2/2]

void tim::component::written_char::sample ( const cache_type & _cache )

inline

sample a measurement from cached data

Definition at line 435 of file components.hpp.

    {
        std::get<0>(accum) = std::get<0>(value) =
            std::max<int64_t>(std::get<0>(value), _cache.get_char_written());
    }

◆ start() [1/2]

void tim::component::written_char::start ( )

inline

Definition at line 372 of file components.hpp.

372{ value = record(); }

tim::component::written_char::record

static value_type record()

Definition: components.hpp:306

References record().

◆ start() [2/2]

void tim::component::written_char::start ( const cache_type & _cache )

inline

start a measurement using the cached data

Definition at line 448 of file components.hpp.

448{ value = record(_cache); }

References record().

◆ stop() [1/2]

void tim::component::written_char::stop ( )

inline

Definition at line 374 of file components.hpp.

    {
        using namespace tim::component::operators;
        auto diff         = (record() - value);
        std::get<0>(diff) = std::abs(std::get<0>(diff));
        accum += (value = diff);
    }

References tim::math::abs, and record().

◆ stop() [2/2]

void tim::component::written_char::stop ( const cache_type & _cache )

inline

stop a measurement using the cached data

Definition at line 451 of file components.hpp.

    {
        using namespace tim::component::operators;
        auto diff         = (record(_cache) - value);
        std::get<0>(diff) = std::abs(std::get<0>(diff));
        accum += (value = diff);
    }

References tim::math::abs, and record().

◆ unit()

static result_type tim::component::written_char::unit ( )

inlinestatic

Definition at line 274 of file components.hpp.

    {
        return result_type{ { units::megabyte,
                              static_cast<double>(units::megabyte) / units::sec } };
    }

Referenced by get_unit(), and unit_array().

◆ unit_array()

static std::array< double, 2 > tim::component::written_char::unit_array ( )

inlinestatic

Definition at line 296 of file components.hpp.

296{ return unit(); }

References unit().

The documentation for this struct was generated from the following file:

timemory/components/io/components.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ base_type

◆ display_unit_type

◆ result_type

◆ storage_type

◆ this_type

◆ unit_type

◆ value_type

Member Function Documentation

◆ description()

◆ description_array()

◆ display_unit()

◆ display_unit_array()

◆ get()

◆ get_display()

◆ get_display_unit()

◆ get_opaque()

◆ get_timestamp()

◆ get_timing_unit()

◆ get_unit()

◆ label()

◆ label_array()

◆ record() [1/2]

◆ record() [2/2]

◆ sample() [1/2]

◆ sample() [2/2]

◆ start() [1/2]

◆ start() [2/2]

◆ stop() [1/2]

◆ stop() [2/2]

◆ unit()

◆ unit_array()