year_month.h

Go to the documentation of this file.

 
 
/******************************************************************************
The MIT License(MIT)
 
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
 
Copyright(c) 2023 John Wellbelove
 
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 ETL_IN_CHRONO_H
  #error DO NOT DIRECTLY INCLUDE THIS FILE. USE CHRONO.H
#endif
 
namespace etl
{
  namespace chrono
  {
    class year_month
    {
    public:
 
      //*************************************************************************
      //*************************************************************************
      ETL_CONSTEXPR year_month()
        : y()
        , m()
      {
      }
 
      //*************************************************************************
      //*************************************************************************
      ETL_CONSTEXPR14 year_month(const etl::chrono::year&  y_, 
                                 const etl::chrono::month& m_) ETL_NOEXCEPT
        : y(y_)
        , m(m_)
      {
      }
 
      //*************************************************************************
      //*************************************************************************
      ETL_NODISCARD
      ETL_CONSTEXPR14 etl::chrono::year year() const ETL_NOEXCEPT
      {
        return y;
      }
 
      //*************************************************************************
      //*************************************************************************
      ETL_NODISCARD
      ETL_CONSTEXPR14 etl::chrono::month month() const ETL_NOEXCEPT
      {
        return m;
      }
 
      //*************************************************************************
      //*************************************************************************
      ETL_NODISCARD
      ETL_CONSTEXPR14 bool ok() const ETL_NOEXCEPT
      {       
        return y.ok() && m.ok();
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_NODISCARD
      ETL_CONSTEXPR14 int compare(const year_month& other) const ETL_NOEXCEPT 
      {
        if (y < other.y) return -1;
        if (y > other.y) return 1;
        if (m < other.m) return -1;
        if (m > other.m) return 1;
      
        return 0;
      }
 
    private:
 
      etl::chrono::year  y;
      etl::chrono::month m;
    };
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year_month operator +(const etl::chrono::year_month& ym,
                                                              const etl::chrono::years&      dy) ETL_NOEXCEPT
    {
      return etl::chrono::year_month(ym.year() + dy, ym.month());
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year_month operator +(const etl::chrono::years&      dy,
                                                              const etl::chrono::year_month& ym) ETL_NOEXCEPT
    {
      return etl::chrono::year_month(ym.year() + dy, ym.month());
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year_month operator +(const etl::chrono::year_month& ym,
                                                              const etl::chrono::months&     dm) ETL_NOEXCEPT
    {
      return etl::chrono::year_month(ym.year(), ym.month() + dm);
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year_month operator +(const etl::chrono::months& dm,
                                                              const etl::chrono::year_month& ym) ETL_NOEXCEPT
    {
      return etl::chrono::year_month(ym.year(), ym.month() + dm);
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year_month operator -(const etl::chrono::year_month& ym,
                                                              const etl::chrono::years&      dy) ETL_NOEXCEPT
    {
      return etl::chrono::year_month(ym.year() - dy, ym.month());
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year_month operator -(const etl::chrono::year_month& ym,
                                                              const etl::chrono::months&     dm) ETL_NOEXCEPT
    {
      return etl::chrono::year_month(ym.year(), ym.month() - dm);
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::months operator -(const etl::chrono::year_month& ym1,
                                                          const etl::chrono::year_month& ym2) ETL_NOEXCEPT
    {
      return etl::chrono::months(static_cast<int>(((int(ym1.year()) - int(ym2.year())) * 12) + (unsigned(ym1.month()) - unsigned(ym2.month()))));
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 bool operator ==(const etl::chrono::year_month& lhs, 
                                            const etl::chrono::year_month& rhs) ETL_NOEXCEPT
    {
      return (lhs.year() == rhs.year()) && (lhs.month() == rhs.month());
    }
 
    //*************************************************************************
    //*************************************************************************
    inline ETL_CONSTEXPR14 bool operator !=(const etl::chrono::year_month& lhs, 
                                            const etl::chrono::year_month& rhs) ETL_NOEXCEPT
    {
      return !(lhs == rhs);
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD ETL_CONSTEXPR14
    inline bool operator <(const etl::chrono::year_month& lhs,
                           const etl::chrono::year_month& rhs) ETL_NOEXCEPT
    {
      if (lhs.year() < rhs.year())
      {
        return true;
      }
      else if (lhs.year() == rhs.year())
      {
        return lhs.month() < rhs.month();
      }
      else
      {
        return false;
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD ETL_CONSTEXPR14
    inline bool operator <=(const etl::chrono::year_month& lhs,
                            const etl::chrono::year_month& rhs) ETL_NOEXCEPT
    {
      return !(rhs < lhs);
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD ETL_CONSTEXPR14
    inline bool operator >(const etl::chrono::year_month& lhs,
                           const etl::chrono::year_month& rhs) ETL_NOEXCEPT
    {
      return rhs < lhs;
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_NODISCARD ETL_CONSTEXPR14
    inline bool operator >=(const etl::chrono::year_month& lhs,
                            const etl::chrono::year_month& rhs) ETL_NOEXCEPT
    {
      return !(lhs < rhs);
    }
 
    //***********************************************************************
    //***********************************************************************
#if ETL_USING_CPP20
    [[nodiscard]] inline constexpr auto operator <=>(const etl::chrono::year_month& lhs, 
                                                     const etl::chrono::year_month& rhs) ETL_NOEXCEPT
    {
      auto cmp = lhs.year()<=> rhs.year();
 
      if (cmp != 0)
      {
        return cmp;
      }
      else
      {
        return lhs.month() <=> rhs.month();
      }
    }
#endif
  }
 
  //*************************************************************************
  //*************************************************************************
#if ETL_USING_8BIT_TYPES
  template <>
  struct hash<etl::chrono::year_month>
  {
    size_t operator()(const etl::chrono::year_month& ym) const
    {    
      etl::chrono::year::rep  y = static_cast<etl::chrono::year::rep>(static_cast<unsigned>(ym.year()));
      etl::chrono::month::rep m = static_cast<etl::chrono::month::rep>(static_cast<unsigned>(ym.month()));
 
      uint8_t buffer[sizeof(y) + sizeof(m)];
 
      memcpy(buffer,             &y, sizeof(y));
      memcpy(buffer + sizeof(y), &m, sizeof(m));
 
      return etl::private_hash::generic_hash<size_t>(buffer, buffer + sizeof(y) + sizeof(m));
    }
  };
#endif
}