vitrio 0.1.4
High-throughput image I/O for Cryo-Electron Microscopy (CryoEM)
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
vitrio::version Class Reference

A version number of three components. More...

#include <vitrio/version.hpp>

Public Member Functions

constexpr version (std::uint32_t major, std::uint32_t minor, std::uint32_t patch) noexcept
 Construct a version from its components.
 
 version (const version &other)=default
 
version & operator= (const version &other)=default
 
constexpr std::uint32_t get_major () const noexcept
 Get the major component.
 
constexpr std::uint32_t get_minor () const noexcept
 Get the minor component.
 
constexpr std::uint32_t get_patch () const noexcept
 Get the patch component.
 

Friends

constexpr bool operator== (const version &lhs, const version &rhs) noexcept
 
constexpr bool operator!= (const version &lhs, const version &rhs) noexcept
 
constexpr bool operator< (const version &lhs, const version &rhs) noexcept
 
constexpr bool operator<= (const version &lhs, const version &rhs) noexcept
 
constexpr bool operator> (const version &lhs, const version &rhs) noexcept
 
constexpr bool operator>= (const version &lhs, const version &rhs) noexcept
 
template<typename T >
std::basic_ostream< T > & operator<< (std::basic_ostream< T > &os, const version &ver)
 

Detailed Description

A version number of three components.

Versions are ordered by their major component, then by their minor component, then by their patch component.

Constructor & Destructor Documentation

◆ version()

constexpr vitrio::version::version ( std::uint32_t  major,
std::uint32_t  minor,
std::uint32_t  patch 
)
constexprnoexcept

Construct a version from its components.

Parameters
majorThe major component.
minorThe minor component.
patchThe patch component.

Member Function Documentation

◆ get_major()

constexpr std::uint32_t vitrio::version::get_major ( ) const
constexprnoexcept

Get the major component.

Returns
std::uint32_t The major component.

◆ get_minor()

constexpr std::uint32_t vitrio::version::get_minor ( ) const
constexprnoexcept

Get the minor component.

Returns
std::uint32_t The minor component.

◆ get_patch()

constexpr std::uint32_t vitrio::version::get_patch ( ) const
constexprnoexcept

Get the patch component.

Returns
std::uint32_t The patch component.

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