#include <atomic_fibonacci.hpp>

Public Member Functions
	AtomicFibonacci (const int &last_number, const int &current_number, const int &max_number=256, const std::string &name="")
virtual int	next ()
virtual int	nextAndLog (const std::string &log_prefix="")
virtual int	nextNext ()
virtual void	setMax (const int &value)
virtual	~AtomicFibonacci ()
Protected Member Functions
	AtomicFibonacci ()
Protected Attributes
std::mutex	mutex_
	Mutex for locking.
Private Member Functions
int	next_ ()
Private Attributes
int	current_number_
	Current Fibonacci number.
int	last_number_
	Last Fibonacci number.
std::string	log_prefix_
	Log prefix.
std::atomic< int >	max_number_
	Max Fibonacci number before reseting the sequence.

Detailed Description

Class which returns the next (or next next) Fibonacci number thread safe

Definition at line 15 of file atomic_fibonacci.hpp.

Constructor & Destructor Documentation

ros1_cpptemplate::AtomicFibonacci::AtomicFibonacci	(	const int &	last_number,
		const int &	current_number,
		const int &	max_number = `256`,
		const std::string &	name = `""`
	)

Constructor If max_number is reached the sqeuence is reset to (0, 1) making last_number_ 0 and current_number_ 1

Parameters:

last_number	Initial last Fibonacci number
current_number	Initial current Fibonacci number
max_number	max_number after the sequence gets reset to (0, 1)
name	Name used for logging prefix

Definition at line 11 of file atomic_fibonacci.cpp.

ros1_cpptemplate::AtomicFibonacci::~AtomicFibonacci ( ) [virtual]

Deconstructor

Definition at line 31 of file atomic_fibonacci.cpp.

ros1_cpptemplate::AtomicFibonacci::AtomicFibonacci ( ) [inline, protected]

Protected default construtor for easy mocking

Definition at line 66 of file atomic_fibonacci.hpp.

Member Function Documentation

int ros1_cpptemplate::AtomicFibonacci::next ( ) [virtual]

Get the next Fibonacci number

Returns:: Next Fibonacci number

Definition at line 43 of file atomic_fibonacci.cpp.

int ros1_cpptemplate::AtomicFibonacci::next_ ( ) [private]

Get the next Fibonacci number without locking

Returns:: Next Fibonacci number

Definition at line 56 of file atomic_fibonacci.cpp.

int ros1_cpptemplate::AtomicFibonacci::nextAndLog ( const std::string & log_prefix = "" ) [virtual]

Get the next Fibonacci number and log it

Returns:: Next Fibonacci number

Definition at line 35 of file atomic_fibonacci.cpp.

int ros1_cpptemplate::AtomicFibonacci::nextNext ( ) [virtual]

Get the Fibonacci number after the next Fibonacci number This advances the sequence of the internal state by two steps (bascially it calls next() twice)