marley::Parity Class Reference

Type-safe representation of a parity value (either +1 or -1) More...

#include <Parity.hh>

Public Member Functions
constexpr	Parity ()
	Default constructor chooses positive parity.
constexpr	Parity (bool is_positive)
	Create a Parity object from a boolean value.
	Parity (int i)
	Create a Parity object from an integer.
void	from_char (const char c)
	Assign a value to this Parity object from a char.
constexpr	operator bool () const
	Convert the Parity object to a bool (true for +1, false for -1)
	operator int () const
Parity &	operator! ()
	Unary operator that flips a Parity value in place.
bool	operator!= (const marley::Parity &p) const
int	operator* (const int &i) const
marley::Parity	operator* (const marley::Parity &p) const
constexpr marley::Parity	operator- () const
	Creates a copy of the Parity object with a flipped value.
marley::Parity &	operator= (const int &i)
	Assigns a parity value using an integer.
bool	operator== (const marley::Parity &p) const
char	to_char () const
	Convert the Parity object to a char.

Protected Attributes
bool	is_positive_
	Boolean representation of the parity value that is true when the parity is +1 and false when it is -1.

Detailed Description

Type-safe representation of a parity value (either +1 or -1)

Definition at line 25 of file Parity.hh.

Constructor & Destructor Documentation

Parity() [1/3]

marley::Parity::Parity ( )

inlineconstexpr

Default constructor chooses positive parity.

Definition at line 30 of file Parity.hh.

: is_positive_(true) {}

References is_positive_.

Referenced by operator!().

Parity() [2/3]

marley::Parity::Parity ( bool is_positive )

inlineexplicitconstexpr

Create a Parity object from a boolean value.

Parameters

is_positive

Boolean parameter that is true for +1, or false for -1.

Definition at line 35 of file Parity.hh.

        : is_positive_(is_positive) {}

References is_positive_.

Parity() [3/3]

marley::Parity::Parity ( int i )

explicit

Create a Parity object from an integer.

If an int value other than +1 or -1 is passed to this constructor, a marley::Error will be thrown.

Definition at line 25 of file Parity.cc.

                            {
  if (i == 1) is_positive_ = true;
  else if (i == -1) is_positive_ = false;
  else throw marley::Error( "Invalid parity " + std::to_string(i)
    + " passed to constructor of marley::Parity" );
}

References is_positive_.

Member Function Documentation

from_char()

void marley::Parity::from_char

(

const char

c

)

Assign a value to this Parity object from a char.

Definition at line 46 of file Parity.cc.

                                           {
  if ( c == '+' ) is_positive_ = true;
  else if ( c == '-' ) is_positive_ = false;
  else throw marley::Error( std::string("Invalid parity character \"") + c
    + "\" encountered in marley::Parity::from_char()" );
}

References is_positive_.

operator bool()

marley::Parity::operator bool ( ) const

inlineexplicitconstexpr

Convert the Parity object to a bool (true for +1, false for -1)

Definition at line 44 of file Parity.hh.

{ return is_positive_; }

References is_positive_.

operator int()

marley::Parity::operator int ( ) const

inlineexplicit

Todo

See comments for marley::TargetAtom::operator int(). A similar situation occurs for this function.

Definition at line 86 of file Parity.hh.

                                           {
        if (is_positive_) return 1;
        else return -1;
      }

References is_positive_.

operator!()

Parity & marley::Parity::operator! ( )

inline

Unary operator that flips a Parity value in place.

Definition at line 52 of file Parity.hh.

                                 {
        is_positive_ = !is_positive_;
        return *this;
      }

References Parity(), and is_positive_.

operator!=()

bool marley::Parity::operator!= ( const marley::Parity & p ) const

inline

Definition at line 67 of file Parity.hh.

      {
        return is_positive_ != p.is_positive_;
      }

operator*() [1/2]

int marley::Parity::operator* ( const int & i ) const

inline

Definition at line 77 of file Parity.hh.

      {
        if (is_positive_) return i;
        else return -i;
      }

operator*() [2/2]

marley::Parity marley::Parity::operator* ( const marley::Parity & p ) const

inline

Definition at line 72 of file Parity.hh.

      {
        return marley::Parity(is_positive_ == p.is_positive_);
      }

operator-()

marley::Parity marley::Parity::operator- ( ) const

inlineconstexpr

Creates a copy of the Parity object with a flipped value.

Definition at line 47 of file Parity.hh.

                                               {
        return marley::Parity(!is_positive_);
      }

References is_positive_.

operator=()

marley::Parity & marley::Parity::operator=

(

const int &

i

)

Assigns a parity value using an integer.

If an int value other than +1 or -1 is used, a marley::Error will be thrown.

Definition at line 35 of file Parity.cc.

                                                    {
  // Do the assignment
  if (i == 1) is_positive_ = true;
  else if (i == -1) is_positive_ = false;
  else throw marley::Error( "Invalid parity " + std::to_string(i)
    + " assigned to variable of type marley::Parity" );
 
  // Return the existing object
  return *this;
}

References is_positive_.

operator==()

bool marley::Parity::operator== ( const marley::Parity & p ) const

inline

Definition at line 62 of file Parity.hh.

      {
        return is_positive_ == p.is_positive_;
      }

to_char()

char marley::Parity::to_char ( ) const

inline

Convert the Parity object to a char.

Definition at line 92 of file Parity.hh.

                                  {
        if (is_positive_) return '+';
        else return '-';
      }

References is_positive_.

Member Data Documentation

is_positive_

bool marley::Parity::is_positive_

protected

Boolean representation of the parity value that is true when the parity is +1 and false when it is -1.

Definition at line 104 of file Parity.hh.

Referenced by Parity(), Parity(), Parity(), from_char(), operator bool(), operator int(), operator!(), operator-(), operator=(), and to_char().

---

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

• /home/sjg/Desktop/marley/include/marley/Parity.hh
• /home/sjg/Desktop/marley/src/Parity.cc