iguana::tools Namespace Reference

Detailed Description

general algorithm tools

Functions
hipo::banklist::size_type	GetBankIndex (hipo::banklist &banks, std::string const &bank_name, unsigned int const &variant=0) noexcept(false)

Function Documentation

GetBankIndex()

hipo::banklist::size_type iguana::tools::GetBankIndex	(	hipo::banklist &	banks,
		std::string const &	bank_name,
		unsigned int const &	variant = 0 )

Get the index of a bank from a hipo::banklist.

Note

this function is preferred over hipo::getBanklistIndex, since it handles the case where there are more than one bank in the banklist with the same name

Parameters

banks	the hipo::banklist from which to get the specified bank
bank_name	the name of the bank
variant	if 0, the first bank named bank_name in banks will be returned; if 1, the 2nd such bank will be returned, etc.; note, you can call Algorithm::GetCreatedBankVariant to get the created-bank variant number for a specific algorithm

Returns

the hipo::banklist index of the bank

See also

Algorithm::GetCreatedBankIndex or AlgorithmSequence::GetCreatedBankIndex to get the index of a bank created by a creator algorithm.