codac2::FunctionArgsList Class Reference

A container class to manage a collection of function arguments. More...

#include <codac2_FunctionArgsList.h>

Public Member Functions
	FunctionArgsList ()
	Default constructor. It creates an empty list of arguments.
	FunctionArgsList (const FunctionArgsList &args)
	Copy constructor.
	FunctionArgsList (std::initializer_list< std::reference_wrapper< VarBase > > args)
	Constructor to initialize a FunctionArgsList from an initializer list of references to VarBase objects.
	FunctionArgsList (const std::vector< std::reference_wrapper< VarBase > > &args)
	Constructor to initialize a FunctionArgsList from a vector of of references to VarBase objects.
Index	total_size () const
	Calculates the total size of the function arguments, as the sum of the sizes of each argument.

Detailed Description

A container class to manage a collection of function arguments.

Constructor & Destructor Documentation

FunctionArgsList() [1/3]

codac2::FunctionArgsList::FunctionArgsList ( const FunctionArgsList & args )

inline

Copy constructor.

Each argument is deep-copied using its arg_copy() method.

Parameters

args	The FunctionArgsList to copy from.

        : std::vector<std::shared_ptr<VarBase>>(args.size())
      {
        size_t i = 0;
        for(const auto& arg : args)
          (*this)[i++] = arg->arg_copy();
        compute_unique_arg_names();
      }

FunctionArgsList() [2/3]

codac2::FunctionArgsList::FunctionArgsList ( std::initializer_list< std::reference_wrapper< VarBase > > args )

inline

Constructor to initialize a FunctionArgsList from an initializer list of references to VarBase objects.

Each argument is deep-copied by calling its arg_copy() on the referenced objects.

Parameters

args	An initializer list of references to VarBase objects.

        : FunctionArgsList(std::vector<std::reference_wrapper<VarBase>>(args))
      { }

FunctionArgsList() [3/3]

codac2::FunctionArgsList::FunctionArgsList ( const std::vector< std::reference_wrapper< VarBase > > & args )

inline

Constructor to initialize a FunctionArgsList from a vector of of references to VarBase objects.

Each argument is deep-copied by calling its arg_copy() on the referenced objects.

Parameters

args	An initializer list of references to VarBase objects.

      {
        for(const auto& arg : args)
          push_back(arg.get().arg_copy());
        compute_unique_arg_names();
      }

Member Function Documentation

total_size()

Index codac2::FunctionArgsList::total_size ( ) const

inline

Calculates the total size of the function arguments, as the sum of the sizes of each argument.

Returns

The sum of the sizes of all arguments.

      {
        Index n = 0;
        for(const auto& ai : *this)
          n += ai->size();
        return n;
      }

---

The documentation for this class was generated from the following file:

• /home/simon/codac/src/core/functions/codac2_FunctionArgsList.h