RAII guard that saves and restores graph cookies. More...

#include <cookie_guard.H>

Collaboration diagram for Aleph::Cookie_Saver< GT >:

Public Types
using	Node = typename GT::Node

using	Arc = typename GT::Arc

using	Node_Cleanup = std::function< void(Node *)>
	Signature for custom cleanup of temporary node cookies.

using	Arc_Cleanup = std::function< void(Arc *)>
	Signature for custom cleanup of temporary arc cookies.

Public Member Functions
	Cookie_Saver (const GT &g, bool _save_nodes=true, bool _save_arcs=true)
	Construct a cookie saver for the given graph.

	Cookie_Saver (const GT &g, Node_Cleanup nc, Arc_Cleanup ac=nullptr)
	Construct with custom cleanup for temporary cookies.

	Cookie_Saver (const Cookie_Saver &)=delete
	Copying disabled.

Cookie_Saver &	operator= (const Cookie_Saver &)=delete

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

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

void	discard () noexcept
	Discard saved cookies without restoring.

void	restore_now ()
	Manually restore cookies now.

const std::vector< std::pair< Node , void > > &	get_saved_node_cookies () const noexcept
	Get access to saved node cookies.

const std::vector< std::pair< Arc , void > > &	get_saved_arc_cookies () const noexcept
	Get access to saved arc cookies.

	~Cookie_Saver ()
	Destructor - restores cookies if saver is still active.

Private Member Functions
void	save_cookies ()

Private Attributes
GT &	graph

std::vector< std::pair< Node , void > >	saved_node_cookies

std::vector< std::pair< Arc , void > >	saved_arc_cookies

bool	save_nodes

bool	save_arcs

Node_Cleanup	node_cleanup

Arc_Cleanup	arc_cleanup

bool	active

Detailed Description

template<class GT>
class Aleph::Cookie_Saver< GT >

RAII guard that saves and restores graph cookies.

This class saves the current cookie values when constructed and restores them when destroyed. Useful when an algorithm needs to temporarily use cookies without losing data from a previous algorithm.

Template Parameters

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

Warning: This class stores pointers to the original cookie values. If the graph structure changes (nodes/arcs added/removed) between save and restore, behavior is undefined.

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

Author: Leandro Rabindranath León

Definition at line 274 of file cookie_guard.H.

Member Typedef Documentation

◆ Arc

template<class GT >

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

Definition at line 278 of file cookie_guard.H.

◆ Arc_Cleanup

template<class GT >

using Aleph::Cookie_Saver< GT >::Arc_Cleanup = std::function<void(Arc*)>

Signature for custom cleanup of temporary arc cookies.

Definition at line 284 of file cookie_guard.H.

◆ Node

template<class GT >

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

Definition at line 277 of file cookie_guard.H.

◆ Node_Cleanup

template<class GT >

using Aleph::Cookie_Saver< GT >::Node_Cleanup = std::function<void(Node*)>

Signature for custom cleanup of temporary node cookies.

Definition at line 281 of file cookie_guard.H.

Constructor & Destructor Documentation

◆ Cookie_Saver() [1/4]

template<class GT >

Aleph::Cookie_Saver< GT >::Cookie_Saver	(	const GT &	g,
		bool	_save_nodes = `true`,
		bool	_save_arcs = `true`
	)

inline

Construct a cookie saver for the given graph.

Immediately saves all current cookie values.

Parameters

g	Graph to save cookies from (const_cast applied - cookies are mutable).
_save_nodes	Whether to save node cookies (default: true).
_save_arcs	Whether to save arc cookies (default: true).

Definition at line 305 of file cookie_guard.H.

References Aleph::Cookie_Saver< GT >::save_cookies().

◆ Cookie_Saver() [2/4]

template<class GT >

Aleph::Cookie_Saver< GT >::Cookie_Saver	(	const GT &	g,
		Node_Cleanup	nc,
		Arc_Cleanup	ac = `nullptr`
	)

inline

Construct with custom cleanup for temporary cookies.

Use this when your algorithm allocates data in cookies that needs to be freed before restoring the original cookies.

Parameters

g	Graph to save cookies from (const_cast applied - cookies are mutable).
nc	Node cleanup function (called before restoring).
ac	Arc cleanup function (called before restoring).

Example: Cookie_Saver<GT> saver(g,

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

nullptr // no arc cleanup needed

);

Aleph::Cookie_Saver
RAII guard that saves and restores graph cookies.
Definition cookie_guard.H:275

Aleph::Cookie_Saver::Node
typename GT::Node Node
Definition cookie_guard.H:277

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