SVF::FIFOWorkList< Data > Class Template Reference

#include <WorkList.h>

Public Member Functions
	FIFOWorkList ()
	FIFOWorkList (const std::vector< Data > &vec)
	Construct from a vector, pushing all elements in order.
	FIFOWorkList (const std::list< Data > &lst)
	Construct from a list, pushing all elements in order.
	~FIFOWorkList ()
bool	empty () const
u32_t	size () const
bool	find (const Data &data) const
bool	push (const Data &data)
void	removeFront ()
Data &	front ()
Data	pop ()
void	clear ()

Private Types
typedef Set< Data >	DataSet
typedef std::deque< Data >	DataDeque

Private Attributes
DataSet	data_set
	store all data in the work list.
DataDeque	data_list
	work list using std::vector.

Detailed Description

template<class Data>
class SVF::FIFOWorkList< Data >

Worklist with "first in first out" order. New nodes will be pushed at back and popped from front. Elements in the list are unique as they're recorded by Set.

Definition at line 138 of file WorkList.h.

Member Typedef Documentation

DataDeque

template<class Data >

typedef std::deque<Data> SVF::FIFOWorkList< Data >::DataDeque

private

Definition at line 141 of file WorkList.h.

DataSet

template<class Data >

typedef Set<Data> SVF::FIFOWorkList< Data >::DataSet

private

Definition at line 140 of file WorkList.h.

Constructor & Destructor Documentation

FIFOWorkList() [1/3]

template<class Data >

SVF::FIFOWorkList< Data >::FIFOWorkList ( )

inline

Definition at line 143 of file WorkList.h.

{}

FIFOWorkList() [2/3]

template<class Data >

SVF::FIFOWorkList< Data >::FIFOWorkList ( const std::vector< Data > &  vec )

inlineexplicit

Construct from a vector, pushing all elements in order.

Definition at line 146 of file WorkList.h.

    {
        for (const Data& d : vec)
            push(d);
    }

FIFOWorkList() [3/3]

template<class Data >

SVF::FIFOWorkList< Data >::FIFOWorkList ( const std::list< Data > &  lst )

inlineexplicit

Construct from a list, pushing all elements in order.

Definition at line 153 of file WorkList.h.

    {
        for (const Data& d : lst)
            push(d);
    }

~FIFOWorkList()

template<class Data >

SVF::FIFOWorkList< Data >::~FIFOWorkList ( )

inline

Definition at line 159 of file WorkList.h.

{}

Member Function Documentation

clear()

template<class Data >

void SVF::FIFOWorkList< Data >::clear ( )

inline

Clear all the data

Definition at line 227 of file WorkList.h.

    {
        data_list.clear();
        data_set.clear();
    }

empty()

template<class Data >

bool SVF::FIFOWorkList< Data >::empty ( ) const

inline

Definition at line 161 of file WorkList.h.

    {
        return data_list.empty();
    }

find()

template<class Data >

bool SVF::FIFOWorkList< Data >::find ( const Data &  data ) const

inline

Definition at line 172 of file WorkList.h.

    {
        return data_set.find(data) != data_set.end();
    }

front()

template<class Data >

Data & SVF::FIFOWorkList< Data >::front ( )

inline

Get reference of top data from the END of work list.

Definition at line 205 of file WorkList.h.

    {
        assert(!empty() && "work list is empty");
        Data &data = data_list.front();
        return data;
    }

pop()

template<class Data >

Data SVF::FIFOWorkList< Data >::pop ( )

inline

Pop a data from the END of work list.

Definition at line 215 of file WorkList.h.

    {
        assert(!empty() && "work list is empty");
        Data data = data_list.front();
        data_list.pop_front();
        data_set.erase(data);
        return data;
    }

push()

template<class Data >

bool SVF::FIFOWorkList< Data >::push ( const Data &  data )

inline

Push a data into the work list.

Definition at line 180 of file WorkList.h.

    {
        if (!find(data))
        {
            data_list.push_back(data);
            data_set.insert(data);
            return true;
        }
        else
            return false;
    }

removeFront()

template<class Data >

void SVF::FIFOWorkList< Data >::removeFront ( )

inline

Remove a data from the END of work list, no return value

Definition at line 195 of file WorkList.h.

    {
        assert(!empty() && "work list is empty");
        data_set.erase(front());
        data_list.pop_front();
    }

size()

template<class Data >

u32_t SVF::FIFOWorkList< Data >::size ( ) const

inline

Definition at line 166 of file WorkList.h.

    {
        assert(data_list.size() == data_set.size() && "list and set must be the same size!");
        return data_list.size();
    }

Member Data Documentation

data_list

template<class Data >

DataDeque SVF::FIFOWorkList< Data >::data_list

private

work list using std::vector.

Definition at line 235 of file WorkList.h.

data_set

template<class Data >

DataSet SVF::FIFOWorkList< Data >::data_set

private

store all data in the work list.

Definition at line 234 of file WorkList.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Util/WorkList.h