SVF::WTOCycleDepth< GraphT > Class Template Reference

#include <WTO.h>

Public Types
typedef GraphT::NodeType	NodeT
typedef NodeRefList::const_iterator	Iterator

Public Member Functions
	WTOCycleDepth ()=default
	Constructor.
	WTOCycleDepth (const WTOCycleDepth &)=default
	Copy constructor.
	WTOCycleDepth (WTOCycleDepth &&)=default
	Move constructor.
WTOCycleDepth &	operator= (const WTOCycleDepth &)=default
	Copy assignment operator.
WTOCycleDepth &	operator= (WTOCycleDepth &&)=default
	Move assignment operator.
	~WTOCycleDepth ()=default
	Destructor.
void	add (const NodeT *head)
	Add a cycle head in the cycleDepth.
Iterator	begin () const
	Begin iterator over the head of cycles.
Iterator	end () const
	End iterator over the head of cycles.
WTOCycleDepth	operator^ (const WTOCycleDepth &other) const
	Return the common prefix of the given cycle depths.
bool	operator< (const WTOCycleDepth &other) const
bool	operator<= (const WTOCycleDepth &other) const
bool	operator== (const WTOCycleDepth &other) const
bool	operator>= (const WTOCycleDepth &other) const
bool	operator> (const WTOCycleDepth &other) const
std::string	toString () const
	Dump the cycleDepth, for debugging purpose.

Private Types
typedef std::vector< const NodeT * >	NodeRefList

Private Member Functions
int	compare (const WTOCycleDepth &other) const
	Compare the given cycle depths.

Private Attributes
NodeRefList	_heads

Friends
std::ostream &	operator<< (std::ostream &o, const WTOCycleDepth< GraphT > &wto)
	Overloading operator << for dumping ICFG node ID.

Detailed Description

template<typename GraphT>
class SVF::WTOCycleDepth< GraphT >

Cycle depth of a WTO Component

The cycle depth is represented as a list of cycle's heads, from the outermost to the innermost.

e.g., consider the following nested cycle:

-->1 --> 2 --> 3 --> 4 \ / <– 6 <– 5 <– \ / >7>

where C1: (1 2 3 4 5 6 7) is the outer cycle, where 1 is the head, and C2: (5 6 7) is the inner cycle, where 5 is the head.

The cycle depth is as following:

| Node NO. | Cycle Depth |

| 1 (head of C1) | [ ] |

| 2, 3, 4 | [1] |

| 5 (head of C2) | [1] |

| 6, 7 | [1, 5] |

Definition at line 100 of file WTO.h.

Member Typedef Documentation

Iterator

template<typename GraphT >

typedef NodeRefList::const_iterator SVF::WTOCycleDepth< GraphT >::Iterator

Definition at line 111 of file WTO.h.

NodeRefList

template<typename GraphT >

typedef std::vector<const NodeT*> SVF::WTOCycleDepth< GraphT >::NodeRefList

private

Definition at line 108 of file WTO.h.

NodeT

template<typename GraphT >

typedef GraphT::NodeType SVF::WTOCycleDepth< GraphT >::NodeT

Definition at line 105 of file WTO.h.

Constructor & Destructor Documentation

WTOCycleDepth() [1/3]

template<typename GraphT >

SVF::WTOCycleDepth< GraphT >::WTOCycleDepth ( )

default

Constructor.

WTOCycleDepth() [2/3]

template<typename GraphT >

SVF::WTOCycleDepth< GraphT >::WTOCycleDepth ( const WTOCycleDepth< GraphT > &  )

default

Copy constructor.

WTOCycleDepth() [3/3]

template<typename GraphT >

SVF::WTOCycleDepth< GraphT >::WTOCycleDepth ( WTOCycleDepth< GraphT > &&  )

default

Move constructor.

~WTOCycleDepth()

template<typename GraphT >

SVF::WTOCycleDepth< GraphT >::~WTOCycleDepth ( )

default

Destructor.

Member Function Documentation

add()

template<typename GraphT >

void SVF::WTOCycleDepth< GraphT >::add ( const NodeT *  head )

inline

Add a cycle head in the cycleDepth.

Definition at line 136 of file WTO.h.

    {
        _heads.push_back(head);
    }

begin()

template<typename GraphT >

Iterator SVF::WTOCycleDepth< GraphT >::begin ( ) const

inline

Begin iterator over the head of cycles.

Definition at line 142 of file WTO.h.

    {
        return _heads.cbegin();
    }

compare()

template<typename GraphT >

int SVF::WTOCycleDepth< GraphT >::compare ( const WTOCycleDepth< GraphT > &  other ) const

inlineprivate

Compare the given cycle depths.

Definition at line 174 of file WTO.h.

    {
        if (this == &other)
        {
            return 0; // equals
        }
 
        auto this_it = begin();
        auto other_it = other.begin();
        while (this_it != end())
        {
            if (other_it == other.end())
            {
                return 1; // `this` is nested within `other`
            }
            else if (*this_it == *other_it)
            {
                ++this_it;
                ++other_it;
            }
            else
            {
                return 2; // not comparable
            }
        }
        if (other_it == other.end())
        {
            return 0; // equals
        }
        else
        {
            return -1; // `other` is nested within `this`
        }
    }

end()

template<typename GraphT >

Iterator SVF::WTOCycleDepth< GraphT >::end ( ) const

inline

End iterator over the head of cycles.

Definition at line 148 of file WTO.h.

    {
        return _heads.cend();
    }

operator<()

template<typename GraphT >

bool SVF::WTOCycleDepth< GraphT >::operator< ( const WTOCycleDepth< GraphT > &  other ) const

inline

Definition at line 210 of file WTO.h.

    {
        return compare(other) == -1;
    }

operator<=()

template<typename GraphT >

bool SVF::WTOCycleDepth< GraphT >::operator<= ( const WTOCycleDepth< GraphT > &  other ) const

inline

Definition at line 215 of file WTO.h.

    {
        return compare(other) <= 0;
    }

operator=() [1/2]

template<typename GraphT >

WTOCycleDepth & SVF::WTOCycleDepth< GraphT >::operator= ( const WTOCycleDepth< GraphT > &  )

default

Copy assignment operator.

operator=() [2/2]

template<typename GraphT >

WTOCycleDepth & SVF::WTOCycleDepth< GraphT >::operator= ( WTOCycleDepth< GraphT > &&  )

default

Move assignment operator.

operator==()

template<typename GraphT >

bool SVF::WTOCycleDepth< GraphT >::operator== ( const WTOCycleDepth< GraphT > &  other ) const

inline

Definition at line 220 of file WTO.h.

    {
        return compare(other) == 0;
    }

operator>()

template<typename GraphT >

bool SVF::WTOCycleDepth< GraphT >::operator> ( const WTOCycleDepth< GraphT > &  other ) const

inline

Definition at line 230 of file WTO.h.

    {
        return compare(other) == 1;
    }

operator>=()

template<typename GraphT >

bool SVF::WTOCycleDepth< GraphT >::operator>= ( const WTOCycleDepth< GraphT > &  other ) const

inline

Definition at line 225 of file WTO.h.

    {
        return operator<=(other, *this);
    }

operator^()

template<typename GraphT >

WTOCycleDepth SVF::WTOCycleDepth< GraphT >::operator^ ( const WTOCycleDepth< GraphT > &  other ) const

inline

Return the common prefix of the given cycle depths.

Definition at line 154 of file WTO.h.

    {
        WTOCycleDepth res;
        for (auto this_it = begin(), other_it = other.begin();
                this_it != end() && other_it != other.end(); ++this_it, ++other_it)
        {
            if (*this_it == *other_it)
            {
                res.add(*this_it);
            }
            else
            {
                break;
            }
        }
        return res;
    }

toString()

template<typename GraphT >

std::string SVF::WTOCycleDepth< GraphT >::toString ( ) const

inline

Dump the cycleDepth, for debugging purpose.

Definition at line 236 of file WTO.h.

    {
        std::string str;
        std::stringstream rawstr(str);
        rawstr << "[";
        for (auto it = begin(), et = end(); it != et;)
        {
            rawstr << (*it)->toString();
            ++it;
            if (it != et)
            {
                rawstr << ", ";
            }
        }
        rawstr << "]";
        return rawstr.str();
    }

Friends And Related Symbol Documentation

operator<<

template<typename GraphT >

std::ostream & operator<< ( std::ostream &  o, const WTOCycleDepth< GraphT > &  wto  )

friend

Overloading operator << for dumping ICFG node ID.

Definition at line 256 of file WTO.h.

    {
        o << wto.toString();
        return o;
    }

Member Data Documentation

_heads

template<typename GraphT >

NodeRefList SVF::WTOCycleDepth< GraphT >::_heads

private

Definition at line 114 of file WTO.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Graphs/WTO.h