metrics.h File Reference

#include <chrono>
#include <cstddef>
#include <iosfwd>

Namespaces
namespace	lucid::metrics
	Collection of metric measuring functions.
namespace	lucid
	Root namespace for the lucid library.

Enumerations
enum class	lucid::metrics::MemoryUnit { lucid::metrics::B , lucid::metrics::KB , lucid::metrics::MB , lucid::metrics::GB }
	Memory units for conversion. More...
enum class	lucid::metrics::TimeUnit {   lucid::metrics::MS , lucid::metrics::S , lucid::metrics::M , lucid::metrics::H ,   lucid::metrics::D }
	Time units for conversion. More...

Functions
size_t	lucid::metrics::get_current_rss ()
	Get the current Resident Set Size (RSS) in bytes.
size_t	lucid::metrics::get_peak_rss ()
	Get the peak Resident Set Size (RSS) in bytes.
template<MemoryUnit U>
double	lucid::metrics::bytes_to (const std::size_t size_in_bytes)
	Convert a size in bytes to the specified memory unit.
double	lucid::metrics::bytes_to (std::size_t size_in_bytes, MemoryUnit unit)
	Convert a size in bytes to the specified memory unit.
MemoryUnit	lucid::metrics::get_suggested_memory_unit (std::size_t size_in_bytes)
	Suggest the most appropriate memory unit for a given size in bytes.
template<TimeUnit U>
double	lucid::metrics::time_to (const double duration_in_seconds)
	Convert a duration in seconds to the specified time unit.
double	lucid::metrics::time_to (double duration_in_seconds, TimeUnit unit)
	Convert a duration in seconds to the specified time unit.
TimeUnit	lucid::metrics::get_suggested_time_unit (double duration_in_seconds)
	Suggest the most appropriate time unit for a given duration in seconds.

Detailed Description

Author

c3054737

Copyright

2025 lucid

Licence:

BSD 3-Clause License

Collection of metric measuring functions.