.. _CollectorVariable:


Collector variable
------------------


 

This variable collects outputs of multiple surrogate models or variables.

.. _ActiveLearning.Collector.name:


name (str)
""""""""""
   The name of the variable under which it can be addressed by other variables or objectives. The name must be distinct from any surrogate name. 

   Default: ``"v"``

.. _ActiveLearning.Collector.output_dim:


output_dim (int)
""""""""""""""""
   Output dimension of variable. 

   Default: This value has no default and must be provided

.. _ActiveLearning.Collector.output_names:


output_names (cell{str})
""""""""""""""""""""""""
   Allows to assign names to each of the  outputs of the variable. By specifying input names  they can be accessed in variables as  ``{output_names[0]}, {output_names[1]}, ..., {output_names[K-1]}``,  where ``K`` is the output dimension. 

   Default:  
   
   By default, the variables can be accessed as  ``{name}0, {name}1, ...,{name}(K-1)``, where ``{name}``  is the name of the variable and ``K`` is the output  dimension.

.. _ActiveLearning.Collector.inputs:


inputs (cell{str})
""""""""""""""""""
   List of names of surrogates or other variables. 

   Default: This value has no default and must be provided