SubstanceAmount.hpp

Go to the documentation of this file.

// Copyright © 2020-2024 Alexandre Coderre-Chabot
//
// This file is part of Physical Quantities (PhQ), a C++ library of physical quantities, physical
// models, and units of measure for scientific computing.
//
// Physical Quantities is hosted at:
//     https://github.com/acodcha/phq
//
// Physical Quantities is licensed under the MIT License:
//     https://mit-license.org
//
// 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.
 
#ifndef PHQ_DIMENSION_SUBSTANCE_AMOUNT_HPP
#define PHQ_DIMENSION_SUBSTANCE_AMOUNT_HPP
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <iostream>
#include <string>
#include <string_view>
 
namespace PhQ::Dimension {
 
/// \brief Base physical dimension of amount of substance. Typically denoted "N". One of seven
/// independent base physical dimensions that form the physical dimension set of any unit of measure
/// or physical quantity. Part of PhQ::Dimensions.
class SubstanceAmount {
public:
  /// \brief Default constructor. Constructs a base physical dimension of amount of substance with a
  /// value of zero.
  constexpr SubstanceAmount() = default;
 
  /// \brief Constructor. Constructs a base physical dimension of amount of substance with a given
  /// value.
  explicit constexpr SubstanceAmount(const int8_t value) : value(value) {}
 
  /// \brief Destructor. Destroys this base physical dimension of amount of substance.
  ~SubstanceAmount() noexcept = default;
 
  /// \brief Copy constructor. Constructs a base physical dimension of amount of substance by
  /// copying another one.
  constexpr SubstanceAmount(const SubstanceAmount& other) = default;
 
  /// \brief Copy assignment operator. Assigns the value of this base physical dimension of amount
  /// of substance by copying from another one.
  constexpr SubstanceAmount& operator=(const SubstanceAmount& other) = default;
 
  /// \brief Move constructor. Constructs a base physical dimension of amount of substance by moving
  /// another one.
  constexpr SubstanceAmount(SubstanceAmount&& other) noexcept = default;
 
  /// \brief Move assignment operator. Assigns the value of this base physical dimension of amount
  /// of substance by moving another one.
  constexpr SubstanceAmount& operator=(SubstanceAmount&& other) noexcept = default;
 
  /// \brief Value of this base physical dimension.
  [[nodiscard]] constexpr int8_t Value() const noexcept {
    return value;
  }
 
  /// \brief Abbreviation of this base physical dimension.
  static std::string_view Abbreviation() noexcept {
    return "N";
  }
 
  /// \brief Label of this base physical dimension.
  static std::string_view Label() noexcept {
    return "Substance Amount";
  }
 
  /// \brief Prints this base physical dimension as a string.
  [[nodiscard]] std::string Print() const noexcept {
    if (value == 0) {
      return {};
    }
    std::string string{Abbreviation()};
    if (value > 1) {
      string.append("^" + std::to_string(value));
    } else if (value < 0) {
      string.append("^(" + std::to_string(value) + ")");
    }
    return string;
  }
 
private:
  /// \brief Value of this base physical dimension.
  int8_t value{0};
};
 
inline constexpr bool operator==(
    const SubstanceAmount& left, const SubstanceAmount& right) noexcept {
  return left.Value() == right.Value();
}
 
inline constexpr bool operator!=(
    const SubstanceAmount& left, const SubstanceAmount& right) noexcept {
  return left.Value() != right.Value();
}
 
inline constexpr bool operator<(
    const SubstanceAmount& left, const SubstanceAmount& right) noexcept {
  return left.Value() < right.Value();
}
 
inline constexpr bool operator>(
    const SubstanceAmount& left, const SubstanceAmount& right) noexcept {
  return left.Value() > right.Value();
}
 
inline constexpr bool operator<=(
    const SubstanceAmount& left, const SubstanceAmount& right) noexcept {
  return left.Value() <= right.Value();
}
 
inline constexpr bool operator>=(
    const SubstanceAmount& left, const SubstanceAmount& right) noexcept {
  return left.Value() >= right.Value();
}
 
inline std::ostream& operator<<(std::ostream& stream, const SubstanceAmount& amount) {
  stream << amount.Print();
  return stream;
}
 
}  // namespace PhQ::Dimension
 
namespace std {
 
template <>
struct hash<PhQ::Dimension::SubstanceAmount> {
  inline size_t operator()(const PhQ::Dimension::SubstanceAmount& amount) const {
    return hash<int8_t>()(amount.Value());
  }
};
 
}  // namespace std
 
#endif  // PHQ_DIMENSION_SUBSTANCE_AMOUNT_HPP