Documentation of geaoptset

Global Index (all files) (short | long) | Local contents | Local Index (files in subdir) (short | long)

Function Synopsis

geaopt = geaoptset(varargin)

Help text

 Create/alters GEAOPTions structure for parameter SETtings of GEA Toolbox

 This function creates or alters geaoptions structures, which include the 
 options of the GEA Toolbox.
 This function can be used for:
  - creating a new complete geaoptions structure, all values set to defaults
  - create a new partial geaoptions structure with given properties
  - combine two or more predefined geaoptions structures into one
  - change given properties of a geaoptions structure 
 The Example section below provides examples for all these possibilities.

 Syntax:  geaopt = geaoptset(P1, P2, P3, P4, ...)

 Input parameter:
    See Examples below for description of possible inputs types and their 
    corresponding functionality.

 Output parameter:
    GEAOPT    - Structure with newly defined options

 Examples:
 
  geaoptset 
     Called with no input and output arguments displays all property names and
     their possible values, including the default value. geaoptset property
     defaults for any unspecified property are taken from the values specified
     inside this function.

  geaopt_full = geaoptset 
     Called with no input arguments returns a geaoptions structure with all 
     possible property names and set to their default value.

  geaopt_part = geaoptset('name', value1, 'name2', value2, ...) 
     Creates a partial geaoptions structure in which the given 
     properties have the specified values.  It is sufficient to 
     type only the leading characters that uniquely identify the property.
     Case is ignored for the property names.
     geaopt_part = geaoptset('Mutation.Name', 'mutint', 'Mutation.Range', 0.1)
        The structure geaopt_part contains just the fields 'Mutation.Name'
        and 'Mutation.Range' set to the specified values.

  geaopt = geaoptset(geaoptold, 'name1', value1, ...) 
     Alters an existing geaoptions structure geaoptold using the given
     properties.
     geaopt_new = geaoptset(geaopt_part, 'Recombination.Name', 'recdis', Mutation.Name', 'mutreal')
        The structure geaopt_part defined in the previous example is extended 
        with the property 'Recombination.Name'. The property 'Mutation.Name' 
        is set to a new value.

  geaopt = geaoptset(geaoptold, geaoptnew) 
     Combines an existing geaoptions structure geaoptold with a new 
     geaoptions structure geaoptnew. Any new properties overwrite 
     corresponding old properties.
     geaopt_all = geaoptset(geaoptset, geaopt_new)
        The full and default structure returned by geaoptset (see second 
        example above) is redefined with the properties from geaopt_new, 
        which was preset in the examples above.

  geaopt = geaoptset(geaoptcheck)
     When called with just one geaoptions structure as input parameter, the values 
     of these properties are checked (violation of boundaries, when multi strategy - then
     the number of values is set to the number of subpopulations and so on).

 See also: paraoptset for a full description, geamain2, compdiv, geaoptprint

Cross-Reference Information