lsst::sphgeom::TriState Class Reference

TriState represents a boolean value with additional unknown state. More...

#include <TriState.h>

Public Member Functions
	TriState ()
	Construct value in unknown state.
	TriState (bool value)
	Construct value in a known state.
TriState &	operator= (TriState const &other)=default
bool	operator== (TriState const &other) const
	Compare this tri-state value with other tri-state value.
bool	operator!= (TriState const &other) const
bool	operator== (bool value) const
	Compare this tri-state value with a boolean.
bool	operator!= (bool value) const
TriState	operator| (TriState const &other) const
	Compute the logical OR of two TriState values.
TriState	operator& (TriState const &other) const
	Compute the logical AND of two TriState values.
TriState	operator~ () const
	Compute the logical NOT of a TriState value.
bool	known () const
	Check whether the state is known.

Detailed Description

TriState represents a boolean value with additional unknown state.

Instances of this class can be compared to booleans true and false, when the state is unknown, comparisons will return false.

Definition at line 46 of file TriState.h.

Constructor & Destructor Documentation

TriState() [1/2]

lsst::sphgeom::TriState::TriState ( )

inline

Construct value in unknown state.

Definition at line 49 of file TriState.h.

{}

TriState() [2/2]

lsst::sphgeom::TriState::TriState ( bool value )

inlineexplicit

Construct value in a known state.

Definition at line 52 of file TriState.h.

: _known(true), _value(value) {}

Member Function Documentation

known()

bool lsst::sphgeom::TriState::known ( ) const

inline

Check whether the state is known.

Returns

True is returned when state is known.

Definition at line 123 of file TriState.h.

{ return _known; }

operator!=() [1/2]

bool lsst::sphgeom::TriState::operator!= ( bool value ) const

inline

Definition at line 79 of file TriState.h.

                                      {
        return not this->operator==(value);
    }

operator!=() [2/2]

bool lsst::sphgeom::TriState::operator!= ( TriState const & other ) const

inline

Definition at line 68 of file TriState.h.

                                                  {
        return not this->operator==(other);
    }

operator&()

TriState lsst::sphgeom::TriState::operator& ( TriState const & other ) const

inline

Compute the logical AND of two TriState values.

Parameters

other

Other TriState value.

Returns

False if either operand is known to be false, true if both operands are known to be true, and unknown otherwise.

Definition at line 101 of file TriState.h.

                                                     {
        if (*this == false || other == false) {
            return TriState(false);
        } else if (*this == true && other == true) {
            return TriState(true);
        } else {
            return TriState();
        }
    }

operator=()

TriState & lsst::sphgeom::TriState::operator= ( TriState const & other )

default

operator==() [1/2]

bool lsst::sphgeom::TriState::operator== ( bool value ) const

inline

Compare this tri-state value with a boolean.

Parameters

value

Boolean value to compare to.

Returns

True if the state is known to be equal to the given boolean.

Definition at line 75 of file TriState.h.

                                      {
        return _known && _value == value;
    }

operator==() [2/2]

bool lsst::sphgeom::TriState::operator== ( TriState const & other ) const

inline

Compare this tri-state value with other tri-state value.

Parameters

other

Tri-state value to compare to.

Returns

True is returned when both states are unknown or when both states are known and values are equal, false returned otherwise.

Definition at line 60 of file TriState.h.

                                                  {
        if (not _known) {
            return not other._known;
        } else {
            return other._known && _value == other._value;
        }
    }

operator|()

TriState lsst::sphgeom::TriState::operator| ( TriState const & other ) const

inline

Compute the logical OR of two TriState values.

Parameters

other

Other TriState value.

Returns

True if either operand is known to be true, false if both operands are known to be false, and unknown otherwise.

Definition at line 87 of file TriState.h.

                                                     {
        if (*this == true || other == true) {
            return TriState(true);
        } else if (*this == false && other == false) {
            return TriState(false);
        } else {
            return TriState();
        }
    }

operator~()

TriState lsst::sphgeom::TriState::operator~ ( ) const

inline

Compute the logical NOT of a TriState value.

Returns

True if the current state is known to be false, false if the current state is known to be true, and unknown otherwise.

Definition at line 114 of file TriState.h.

                               {
        if (known()) {
            return TriState(!_value);
        }
        return TriState();
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/sphgeom/g7b71ed6315+fcb1d3bbc8/include/lsst/sphgeom/TriState.h