Core/Shape.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <iostream>
#include <string>
 
#include "NumCpp/Core/Types.hpp"
#include "NumCpp/Utils/num2str.hpp"
 
namespace nc
{
    //================================================================================
    class Shape
    {
    public:
        //====================================Attributes==============================
        uint32 rows{ 0 };
        uint32 cols{ 0 };
 
        //============================================================================
        constexpr Shape() = default;
 
        //============================================================================
        constexpr explicit Shape(uint32 inSquareSize) noexcept :
            rows(inSquareSize),
            cols(inSquareSize)
        {
        }
 
        //============================================================================
        constexpr Shape(uint32 inRows, uint32 inCols) noexcept :
            rows(inRows),
            cols(inCols)
        {
        }
 
        //============================================================================
        bool operator==(const Shape& inOtherShape) const noexcept
        {
            return rows == inOtherShape.rows && cols == inOtherShape.cols;
        }
 
        //============================================================================
        bool operator!=(const Shape& inOtherShape) const noexcept
        {
            return !(*this == inOtherShape);
        }
 
        //============================================================================
        [[nodiscard]] uint32 size() const noexcept
        {
            return rows * cols;
        }
 
        //============================================================================
        [[nodiscard]] bool isnull() const noexcept
        {
            return rows == 0 && cols == 0;
        }
 
        //============================================================================
        [[nodiscard]] bool issquare() const noexcept
        {
            return rows == cols;
        }
 
        //============================================================================
        [[nodiscard]] std::string str() const
        {
            std::string out = "[" + utils::num2str(rows) + ", " + utils::num2str(cols) + "]\n";
            return out;
        }
 
        //============================================================================
        void print() const
        {
            std::cout << *this;
        }
 
        //============================================================================
        friend std::ostream& operator<<(std::ostream& inOStream, const Shape& inShape)
        {
            inOStream << inShape.str();
            return inOStream;
        }
    };
} // namespace nc