scifir::pixel Class Reference

#include <pixel.hpp>

Public Member Functions
	pixel ()
	pixel (const pixel &x)
	pixel (pixel &&x)
	pixel (float new_value)
	pixel (double new_value)
	pixel (long double new_value)
	pixel (int new_value)
	pixel (const string &init_pixel)
	pixel (const scalar_unit &x)
pixel &	operator= (const pixel &x)
pixel &	operator= (pixel &&x)
pixel &	operator= (float new_value)
pixel &	operator= (const string &init_pixel)
pixel &	operator= (const scalar_unit &x)
	operator float () const
const float &	get_value () const
pixel	operator+ (const pixel &x) const
pixel	operator- (const pixel &x) const
pixel	operator* (const pixel &x) const
pixel	operator/ (const pixel &x) const
pixel	operator^ (const pixel &x) const
void	operator+= (const pixel &x)
void	operator-= (const pixel &x)
void	operator*= (const pixel &x)
void	operator/= (const pixel &x)
void	operator^= (const pixel &x)
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator= (T x)
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
pixel	operator+ (T x) const
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
pixel	operator- (T x) const
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
pixel	operator* (T x) const
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
pixel	operator/ (T x) const
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
pixel	operator^ (T x) const
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator+= (T x)
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator-= (T x)
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator*= (T x)
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator/= (T x)
template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>
void	operator^= (T x)
pixel &	operator++ ()
pixel	operator++ (int)
pixel &	operator-- ()
pixel	operator-- (int)
scalar_unit	to_scalar_unit () const
string	display (int number_of_decimals=2) const

Private Member Functions
void	initialize_from_string (const string &init_pixel)

Private Attributes
float	value

Detailed Description

Definition at line 17 of file pixel.hpp.

Constructor & Destructor Documentation

pixel() [1/9]

scifir::pixel::pixel

(

)

Definition at line 16 of file pixel.cpp.

                 : value(0)
    {}

pixel() [2/9]

scifir::pixel::pixel

(

const pixel &

x

)

Definition at line 19 of file pixel.cpp.

                               : value(x.get_value())
    {}

pixel() [3/9]

scifir::pixel::pixel

(

pixel &&

x

)

Definition at line 22 of file pixel.cpp.

                          : value(std::move(x.get_value()))
    {}

pixel() [4/9]

scifir::pixel::pixel ( float  new_value )

explicit

Definition at line 25 of file pixel.cpp.

                                : value(new_value)
    {}

pixel() [5/9]

scifir::pixel::pixel ( double  new_value )

explicit

Definition at line 28 of file pixel.cpp.

                                 : value(float(new_value))
    {}

pixel() [6/9]

scifir::pixel::pixel ( long double  new_value )

explicit

Definition at line 31 of file pixel.cpp.

                                      : value(float(new_value))
    {}

pixel() [7/9]

scifir::pixel::pixel ( int  new_value )

explicit

Definition at line 34 of file pixel.cpp.

                              : value(float(new_value))
    {}

pixel() [8/9]

scifir::pixel::pixel ( const string &  init_pixel )

explicit

Definition at line 37 of file pixel.cpp.

                                         : value()
    {
        initialize_from_string(init_pixel);
    }

pixel() [9/9]

scifir::pixel::pixel ( const scalar_unit &  x )

explicit

Definition at line 42 of file pixel.cpp.

    {
        if (x.has_empty_dimensions())
        {
            value = float(x);
        }
        else
        {
            cerr << "An pixel cannot be initialized with dimensions" << endl;
            value = 0;
        }
    }

Member Function Documentation

display()

string scifir::pixel::display

(

int

number_of_decimals = 2

)

const

Definition at line 173 of file pixel.cpp.

    {
        ostringstream output;
        output << display_float(value,number_of_decimals) << " px";
        return output.str();
    }

get_value()

const float & scifir::pixel::get_value ( ) const

inline

Definition at line 41 of file pixel.hpp.

            {
                return value;
            }

initialize_from_string()

void scifir::pixel::initialize_from_string ( const string &  init_pixel )

private

Definition at line 180 of file pixel.cpp.

    {
        if (init_pixel.substr(init_pixel.length() - 3,3) == " px")
        {
            value = stof(init_pixel.substr(0,init_pixel.length() - 3));
        }
        else if (init_pixel.substr(init_pixel.length() - 2,2) == "px")
        {
            value = stof(init_pixel.substr(0,init_pixel.length() - 2));
        }
        else
        {
            value = stof(init_pixel);
        }
    }

operator float()

scifir::pixel::operator float ( ) const

inlineexplicit

Definition at line 36 of file pixel.hpp.

            {
                return float(value);
            }

operator*() [1/2]

pixel scifir::pixel::operator*

(

const pixel &

x

)

const

Definition at line 102 of file pixel.cpp.

    {
        return pixel(value * x.get_value());
    }

operator*() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

pixel scifir::pixel::operator* ( T  x ) const

inline

Definition at line 76 of file pixel.hpp.

            {
                return pixel(value * x);
            }

operator*=() [1/2]

void scifir::pixel::operator*=

(

const pixel &

x

)

Definition at line 127 of file pixel.cpp.

    {
        value *= x.get_value();
    }

operator*=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void scifir::pixel::operator*= ( T  x )

inline

Definition at line 106 of file pixel.hpp.

            {
                value *= x;
            }

operator+() [1/2]

pixel scifir::pixel::operator+

(

const pixel &

x

)

const

Definition at line 92 of file pixel.cpp.

    {
        return pixel(value + x.get_value());
    }

operator+() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

pixel scifir::pixel::operator+ ( T  x ) const

inline

Definition at line 64 of file pixel.hpp.

            {
                return pixel(value + x);
            }

operator++() [1/2]

pixel & scifir::pixel::operator++

(

)

Definition at line 142 of file pixel.cpp.

    {
        value++;
        return *this;
    }

operator++() [2/2]

pixel scifir::pixel::operator++

(

int

)

Definition at line 148 of file pixel.cpp.

    {
        pixel tmp = pixel(*this);
        operator ++();
        return tmp;
    }

operator+=() [1/2]

void scifir::pixel::operator+=

(

const pixel &

x

)

Definition at line 117 of file pixel.cpp.

    {
        value += x.get_value();
    }

operator+=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void scifir::pixel::operator+= ( T  x )

inline

Definition at line 94 of file pixel.hpp.

            {
                value += x;
            }

operator-() [1/2]

pixel scifir::pixel::operator-

(

const pixel &

x

)

const

Definition at line 97 of file pixel.cpp.

    {
        return pixel(value - x.get_value());
    }

operator-() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

pixel scifir::pixel::operator- ( T  x ) const

inline

Definition at line 70 of file pixel.hpp.

            {
                return pixel(value - x);
            }

operator--() [1/2]

pixel & scifir::pixel::operator--

(

)

Definition at line 155 of file pixel.cpp.

    {
        value--;
        return *this;
    }

operator--() [2/2]

pixel scifir::pixel::operator--

(

int

)

Definition at line 161 of file pixel.cpp.

    {
        pixel tmp = pixel(*this);
        operator --();
        return tmp;
    }

operator-=() [1/2]

void scifir::pixel::operator-=

(

const pixel &

x

)

Definition at line 122 of file pixel.cpp.

    {
        value -= x.get_value();
    }

operator-=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void scifir::pixel::operator-= ( T  x )

inline

Definition at line 100 of file pixel.hpp.

            {
                value -= x;
            }

operator/() [1/2]

pixel scifir::pixel::operator/

(

const pixel &

x

)

const

Definition at line 107 of file pixel.cpp.

    {
        return pixel(value / x.get_value());
    }

operator/() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

pixel scifir::pixel::operator/ ( T  x ) const

inline

Definition at line 82 of file pixel.hpp.

            {
                return pixel(value / x);
            }

operator/=() [1/2]

void scifir::pixel::operator/=

(

const pixel &

x

)

Definition at line 132 of file pixel.cpp.

    {
        value /= x.get_value();
    }

operator/=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void scifir::pixel::operator/= ( T  x )

inline

Definition at line 112 of file pixel.hpp.

            {
                value /= x;
            }

operator=() [1/6]

pixel & scifir::pixel::operator=

(

const pixel &

x

)

Definition at line 55 of file pixel.cpp.

    {
        value = x.get_value();
        return *this;
    }

operator=() [2/6]

pixel & scifir::pixel::operator=

(

const scalar_unit &

x

)

Definition at line 79 of file pixel.cpp.

    {
        if (x.has_empty_dimensions())
        {
            value = x.get_value();
        }
        else
        {
            cerr << "An pixel cannot be initialized with dimensions" << endl;
        }
        return *this;
    }

operator=() [3/6]

pixel & scifir::pixel::operator=

(

const string &

init_pixel

)

Definition at line 73 of file pixel.cpp.

    {
        initialize_from_string(init_pixel);
        return *this;
    }

operator=() [4/6]

pixel & scifir::pixel::operator=

(

float

new_value

)

Definition at line 67 of file pixel.cpp.

    {
        value = new_value;
        return *this;
    }

operator=() [5/6]

pixel & scifir::pixel::operator=

(

pixel &&

x

)

Definition at line 61 of file pixel.cpp.

    {
        value = std::move(x.get_value());
        return *this;
    }

operator=() [6/6]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void scifir::pixel::operator= ( T  x )

inline

Definition at line 58 of file pixel.hpp.

            {
                value = x;
            }

operator^() [1/2]

pixel scifir::pixel::operator^

(

const pixel &

x

)

const

Definition at line 112 of file pixel.cpp.

    {
        return pixel(std::pow(value,x.get_value()));
    }

operator^() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

pixel scifir::pixel::operator^ ( T  x ) const

inline

Definition at line 88 of file pixel.hpp.

            {
                return pixel(std::pow(value, x));
            }

operator^=() [1/2]

void scifir::pixel::operator^=

(

const pixel &

x

)

Definition at line 137 of file pixel.cpp.

    {
        value = std::pow(value,x.get_value());
    }

operator^=() [2/2]

template<typename T , typename = typename enable_if<scifir::is_number<T>::value>::type>

void scifir::pixel::operator^= ( T  x )

inline

Definition at line 118 of file pixel.hpp.

            {
                value = std::pow(value, x);
            }

to_scalar_unit()

scalar_unit scifir::pixel::to_scalar_unit

(

)

const

Definition at line 168 of file pixel.cpp.

    {
        return scalar_unit(value, { dimension(dimension::PIXEL, prefix::NONE, dimension::NUMERATOR) });
    }

Member Data Documentation

value

float scifir::pixel::value

private

Definition at line 133 of file pixel.hpp.

---

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

• special_units/pixel.hpp
• special_units/pixel.cpp