CodeSonar C++ API
[For improved navigation, enable JavaScript.]
Public Types | Public Member Functions | Related Functions | List of all members
cs::cfg_edge_set Class Reference

A set of cfg_edge. More...

Public Types

typedef iterator const_iterator
 const iterator over the set contents. More...
 
typedef const cfg_edgeconst_pointer
 const pointer to the type of the set elements. More...
 
typedef const cfg_edgeconst_reference
 const reference to the type of the set elements. More...
 
typedef cfg_edge_set_iterator  iterator
 Iterator over the set contents. More...
 
typedef cfg_edge key_type
 The type of the set elements. More...
 
typedef cfg_edgepointer
 Pointer to the type of the set elements. More...
 
typedef cfg_edgereference
 Reference to the type of the set elements. More...
 
typedef size_t size_type
 Type of set size (cardinality). More...
 
typedef cfg_edge value_type
 The type of the set elements. More...
 

Public Member Functions

 cfg_edge_set (const cfg_edge_set &other)
 Copy constructor. More...
 
std::string as_repr () const
 Get a representation of a set that includes information useful for debugging. More...
 
std::string as_string () const
 Get a simple string representation of a set. More...
 
iterator begin () const
 Get an iterator whose current position is the first element in the set. More...
 
iterator cbegin () const
 Get an iterator whose current position is the first element in the set. More...
 
iterator cend () const
 Get an iterator whose current position is after the end of the set. More...
 
size_type count (const cfg_edge &e) const
 Count the number of times the specified element appears in a set. More...
 
bool empty () const
 Check: is the set empty? More...
 
iterator end () const
 Get an iterator whose current position is after the end of the set. More...
 
const_iterator find (const cfg_edge &e) const
 Find element e in the set and return an iterator pointing to it if it is found. More...
 
cs_hash_t hash () const
 Get a hash of the set. More...
 
cfg_edge_setoperator= (cfg_edge_set other)
 Assignment operator for cfg_edge_set. More...
 
size_type size () const
 Get the set cardinality. More...
 
void swap (cfg_edge_set &other)
 Exchange the contents of this and other. More...
 
std::vector< cfg_edgeto_vector () const
 Get a std::vector of all the elements in the set. More...
 

Related Functions

(Note that these are not member functions.)

bool operator!= (const cfg_edge_set &__x, const cfg_edge_set &__y)
 Inequality operator for cfg_edge_set. More...
 
std::ostream & operator<< (std::ostream &out, const cfg_edge_set &a)
 Print a representation of a cfg_edge_set object to the specified stream. More...
 
bool operator== (const cfg_edge_set &__x, const cfg_edge_set &__y)
 Equality operator for cfg_edge_set. More...
 

Detailed Description

A set of cfg_edge.

Return type for CFG-related queries on point : point::cfg_inter_targets(), point::cfg_targets()

Use a cfg_edge_set_iterator to iterate over a cfg_edge_set. For example:

for (cs::cfg_edge_set_iterator it = my_cfg_edge_set.begin(); !it.at_end(); ++it){
std::cout << "cfg_edge: " << *it;
}

Member Typedef Documentation

◆ const_iterator

typedef iterator cs::cfg_edge_set::const_iterator
inherited

const iterator over the set contents.

◆ const_pointer

typedef const cfg_edge * cs::cfg_edge_set::const_pointer
inherited

const pointer to the type of the set elements.

◆ const_reference

typedef const cfg_edge & cs::cfg_edge_set::const_reference
inherited

const reference to the type of the set elements.

◆ iterator

typedef cfg_edge_set_iterator cs::cfg_edge_set::iterator
inherited

Iterator over the set contents.

◆ key_type

typedef cfg_edge cs::cfg_edge_set::key_type
inherited

The type of the set elements.

◆ pointer

typedef cfg_edge * cs::cfg_edge_set::pointer
inherited

Pointer to the type of the set elements.

◆ reference

typedef cfg_edge & cs::cfg_edge_set::reference
inherited

Reference to the type of the set elements.

◆ size_type

typedef size_t cs::cfg_edge_set::size_type
inherited

Type of set size (cardinality).

◆ value_type

typedef cfg_edge cs::cfg_edge_set::value_type
inherited

The type of the set elements.

Constructor & Destructor Documentation

◆ cfg_edge_set()

cs::cfg_edge_set::cfg_edge_set ( const cfg_edge_set other)

Copy constructor.

Member Function Documentation

◆ as_repr()

std::string cs::cfg_edge_set::as_repr ( ) const
inlineinherited

Get a representation of a set that includes information useful for debugging.

Returns
The string representation.

◆ as_string()

std::string cs::cfg_edge_set::as_string ( ) const
inlineinherited

Get a simple string representation of a set.

Returns
The string representation.

◆ begin()

iterator cs::cfg_edge_set::begin ( ) const
inlineinherited

Get an iterator whose current position is the first element in the set.

Returns
The iterator.

◆ cbegin()

iterator cs::cfg_edge_set::cbegin ( ) const
inlineinherited

Get an iterator whose current position is the first element in the set.

Returns
The iterator.

◆ cend()

iterator cs::cfg_edge_set::cend ( ) const
inlineinherited

Get an iterator whose current position is after the end of the set.

Returns
The iterator.

◆ count()

size_type cs::cfg_edge_set::count ( const cfg_edge e) const
inlineinherited

Count the number of times the specified element appears in a set.

Parameters
[in]eThe element of interest.
Returns
1 if e is present in the set, 0 otherwise.

◆ empty()

bool cs::cfg_edge_set::empty ( ) const
inlineinherited

Check: is the set empty?

Returns
true if the set is empty, false otherwise.

◆ end()

iterator cs::cfg_edge_set::end ( ) const
inlineinherited

Get an iterator whose current position is after the end of the set.

Returns
The iterator.

◆ find()

const_iterator cs::cfg_edge_set::find ( const cfg_edge e) const
inlineinherited

Find element e in the set and return an iterator pointing to it if it is found.

Returns
An iterator whose current position is:
  • the set element matching e if e is present in the set,
  • after the end of the set otherwise.

◆ hash()

cs_hash_t cs::cfg_edge_set::hash ( ) const
inlineinherited

Get a hash of the set.

Returns
The hash value for the set.

◆ operator=()

cfg_edge_set& cs::cfg_edge_set::operator= ( cfg_edge_set  other)

Assignment operator for cfg_edge_set.

◆ size()

size_type cs::cfg_edge_set::size ( ) const
inlineinherited

Get the set cardinality.

Returns
The number of elements in the set.

◆ swap()

void cs::cfg_edge_set::swap ( cfg_edge_set other)
inlineinherited

Exchange the contents of this and other.

◆ to_vector()

std::vector<cfg_edge > cs::cfg_edge_set::to_vector ( ) const
inlineinherited

Get a std::vector of all the elements in the set.

Returns
A std::vector containing all the elements in the set.

Friends And Related Function Documentation

◆ operator!=()

bool operator!= ( const cfg_edge_set __x,
const cfg_edge_set __y 
)
related

Inequality operator for cfg_edge_set.

Parameters
[in]__xThe set to compare.
[in]__yThe set to compare against.
Returns
false if __x == __y according to operator==(), true otherwise.

◆ operator<<()

std::ostream & operator<< ( std::ostream &  out,
const cfg_edge_set a 
)
related

Print a representation of a cfg_edge_set object to the specified stream.

Parameters
[in]outThe stream to print to.
[in]aThe cfg_edge_set object to print.
Returns
void

◆ operator==()

bool operator== ( const cfg_edge_set __x,
const cfg_edge_set __y 
)
related

Equality operator for cfg_edge_set.

Parameters
[in]__xThe set to compare.
[in]__yThe set to compare against.
Returns
true if __x == __y, false otherwise.

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