RAII guard that clears graph cookies on destruction. More...

#include <cookie_guard.H>

Collaboration diagram for Aleph::Cookie_Guard< GT >:

Public Types
using	Node = typename GT::Node

using	Arc = typename GT::Arc

using	Node_Deleter = std::function< void(Node *)>
	Signature for custom node cookie deleter.

using	Arc_Deleter = std::function< void(Arc *)>
	Signature for custom arc cookie deleter.

Public Member Functions
	Cookie_Guard (const GT &g, bool _clear_nodes=true, bool _clear_arcs=true) noexcept
	Construct a cookie guard for the given graph.

	Cookie_Guard (const GT &g, Node_Deleter nd, Arc_Deleter ad=nullptr) noexcept
	Construct with custom deleters for cookie data.

	Cookie_Guard (const Cookie_Guard &)=delete
	Copying disabled.

Cookie_Guard &	operator= (const Cookie_Guard &)=delete

	Cookie_Guard (Cookie_Guard &&other) noexcept
	Move construction transfers ownership.

Cookie_Guard &	operator= (Cookie_Guard &&other) noexcept
	Move assignment transfers ownership.

void	release () noexcept
	Release the guard without clearing cookies.

void	clear_now ()
	Manually trigger cleanup now.

	~Cookie_Guard ()
	Destructor - clears cookies if guard is still active.

Private Attributes
GT &	graph

bool	clear_nodes

bool	clear_arcs

Node_Deleter	node_deleter

Arc_Deleter	arc_deleter

bool	active

Detailed Description

template<class GT>
class Aleph::Cookie_Guard< GT >

RAII guard that clears graph cookies on destruction.

This class provides automatic cleanup of node and arc cookies when the guard goes out of scope. This is essential for exception safety in graph algorithms.

Template Parameters

GT	Graph type (must have Node and Arc types with cookies).

Thread Safety: Not thread-safe. Each thread should use its own guard.

Author: Leandro Rabindranath León

Definition at line 119 of file cookie_guard.H.

Member Typedef Documentation

◆ Arc

template<class GT >

using Aleph::Cookie_Guard< GT >::Arc = typename GT::Arc

Definition at line 123 of file cookie_guard.H.

◆ Arc_Deleter

template<class GT >

using Aleph::Cookie_Guard< GT >::Arc_Deleter = std::function<void(Arc*)>

Signature for custom arc cookie deleter.

Definition at line 129 of file cookie_guard.H.

◆ Node

template<class GT >

using Aleph::Cookie_Guard< GT >::Node = typename GT::Node

Definition at line 122 of file cookie_guard.H.

◆ Node_Deleter

template<class GT >

using Aleph::Cookie_Guard< GT >::Node_Deleter = std::function<void(Node*)>

Signature for custom node cookie deleter.

Definition at line 126 of file cookie_guard.H.

Constructor & Destructor Documentation

◆ Cookie_Guard() [1/4]

template<class GT >

Aleph::Cookie_Guard< GT >::Cookie_Guard	(	const GT &	g,
		bool	_clear_nodes = `true`,
		bool	_clear_arcs = `true`
	)

inlinenoexcept

Construct a cookie guard for the given graph.

Parameters

g	Graph to guard (const_cast applied - cookies are mutable).
_clear_nodes	Whether to clear node cookies (default: true).
_clear_arcs	Whether to clear arc cookies (default: true).

Definition at line 146 of file cookie_guard.H.

◆ Cookie_Guard() [2/4]

template<class GT >

Aleph::Cookie_Guard< GT >::Cookie_Guard	(	const GT &	g,
		Node_Deleter	nd,
		Arc_Deleter	ad = `nullptr`
	)

inlinenoexcept

Construct with custom deleters for cookie data.

Use this constructor when cookies point to dynamically allocated data that needs to be freed.

Parameters

g	Graph to guard (const_cast applied - cookies are mutable).
nd	Node deleter function (called for each node before clearing).
ad	Arc deleter function (called for each arc before clearing).

Example: Cookie_Guard<GT> guard(g,

[](Node* p) { delete static_cast<MyNodeData*>(NODE_COOKIE(p)); },

[](Arc* a) { delete static_cast<MyArcData*>(ARC_COOKIE(a)); }

);

Arc
WeightedDigraph::Arc Arc
Definition bellman_ford_example.cc:141

Aleph::Cookie_Guard
RAII guard that clears graph cookies on destruction.
Definition cookie_guard.H:120

Aleph::Cookie_Guard::Node
typename GT::Node Node
Definition cookie_guard.H:122

ARC_COOKIE
#define ARC_COOKIE(p)
Return the arc cookie
Definition aleph-graph.H:394

NODE_COOKIE
#define NODE_COOKIE(p)
Return the node cookie
Definition aleph-graph.H:361

Aleph::maps
DynList< T > maps(const C &c, Op op)
Classic map operation.
Definition ahFunctional.H:693

Definition at line 168 of file cookie_guard.H.

◆ Cookie_Guard() [3/4]

template<class GT >

Aleph::Cookie_Guard< GT >::Cookie_Guard ( const Cookie_Guard< GT > & )

delete

Copying disabled.

◆ Cookie_Guard() [4/4]

template<class GT >

Aleph::Cookie_Guard< GT >::Cookie_Guard ( Cookie_Guard< GT > && other )

inlinenoexcept

Move construction transfers ownership.

Definition at line 178 of file cookie_guard.H.

References Aleph::maps().

◆ ~Cookie_Guard()

template<class GT >

Aleph::Cookie_Guard< GT >::~Cookie_Guard ( )

inline

Destructor - clears cookies if guard is still active.

Definition at line 248 of file cookie_guard.H.

References Aleph::Cookie_Guard< GT >::clear_now().

Referenced by Aleph::compute_cut_nodes().

Member Function Documentation

◆ clear_now()

template<class GT >

void Aleph::Cookie_Guard< GT >::clear_now ( )

inline

Manually trigger cleanup now.

Clears cookies immediately and deactivates the guard.

Definition at line 217 of file cookie_guard.H.

References Aleph::Cookie_Guard< GT >::active, ARC_COOKIE, Aleph::Cookie_Guard< GT >::arc_deleter, Aleph::Cookie_Guard< GT >::clear_arcs, Aleph::Cookie_Guard< GT >::clear_nodes, GraphCommon< GT, Node, Arc >::get_arc_it(), GraphCommon< GT, Node, Arc >::get_node_it(), Aleph::Cookie_Guard< GT >::graph, Aleph::maps(), NODE_COOKIE, and Aleph::Cookie_Guard< GT >::node_deleter.

Referenced by Aleph::Cookie_Guard< GT >::~Cookie_Guard().

◆ operator=() [1/2]

template<class GT >

Cookie_Guard & Aleph::Cookie_Guard< GT >::operator= ( const Cookie_Guard< GT > & )

delete

◆ operator=() [2/2]

template<class GT >

Cookie_Guard & Aleph::Cookie_Guard< GT >::operator= ( Cookie_Guard< GT > && other )

inlinenoexcept

Move assignment transfers ownership.

Definition at line 187 of file cookie_guard.H.

References Aleph::Cookie_Guard< GT >::active, Aleph::Cookie_Guard< GT >::arc_deleter, Aleph::Cookie_Guard< GT >::clear_arcs, Aleph::Cookie_Guard< GT >::clear_nodes, Aleph::maps(), Aleph::Cookie_Guard< GT >::node_deleter, and Aleph::Cookie_Guard< GT >::release().

◆ release()

template<class GT >

void Aleph::Cookie_Guard< GT >::release ( )

inlinenoexcept

Release the guard without clearing cookies.

Call this if you want to keep the cookies after the guard goes out of scope (e.g., algorithm completed successfully and results are stored in cookies).

Definition at line 208 of file cookie_guard.H.

References Aleph::Cookie_Guard< GT >::active.

Referenced by Aleph::Cookie_Guard< GT >::operator=().