Main driver for working out if a class (normally goto_programt) has any natural loops. More...

Inheritance diagram for natural_loops_templatet< P, T, C >:

Collaboration diagram for natural_loops_templatet< P, T, C >:

Public Types
typedef parentt::loopt	natural_loopt

Public Types inherited from loop_analysist< T, C >
typedef loop_templatet< T, C >	loopt

typedef std::map< T, loopt, C >	loop_mapt

Public Member Functions
void	operator() (P &program)

const cfg_dominators_templatet< P, T, false > &	get_dominator_info () const

	natural_loops_templatet ()

	natural_loops_templatet (P &program)

Public Member Functions inherited from loop_analysist< T, C >
virtual void	output (std::ostream &) const
	Print all natural loops that were found. More...

bool	is_loop_header (const T instruction) const
	Returns true if `instruction` is the header of any loop. More...

	loop_analysist ()=default

Protected Types
typedef cfg_dominators_templatet< P, T, false >::cfgt::nodet	nodet

Protected Member Functions
void	compute (P &program)
	Finds all back-edges and computes the natural loops. More...

void	compute_natural_loop (T, T)
	Computes the natural loop for a given back-edge (see Muchnick section 7.4) More...

Protected Attributes
cfg_dominators_templatet< P, T, false >	cfg_dominators

Additional Inherited Members
Public Attributes inherited from loop_analysist< T, C >
loop_mapt	loop_map

Detailed Description

Main driver for working out if a class (normally goto_programt) has any natural loops.

compute takes an entire goto_programt, iterates over the instructions and for any backwards jumps attempts to find out if it's a natural loop.

All instructions in a natural loop are stored into loop_map, keyed by their head - the target of the backwards goto jump.

Template Parameters

P	the program representation and needs: [field] instruction which is an iterable of type T.
T	iterator of the particular node type, e.g. std::list<...>::iterator. The object this iterator holds needs: [function] is_backwards_goto() returning a bool. [function] get_target() which returns an object that needs: [field] location_number which is an unsigned int.
C	comparison to use over `T` typed elements

Definition at line 48 of file natural_loops.h.