Documentation of paraoptset

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

Function Synopsis

paraopt = paraoptset(PARAOPTDEF, varargin)

Help text

 Create/alters OPTions structure for parameter SETtings

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

 Syntax:  paraopt = paraoptset(P1, P2, P3, P4, ...)

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

 Output parameter:
    PARAOPT    - Structure with newly defined options

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

  paraopt_full = paraoptset 
     Called with no input arguments returns a paraoptions structure with all 
     possible property names and set to their default value.

  paraopt_part = paraoptset('name', value1, 'name2', value2, ...) 
     Creates a partial paraoptions 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.
     paraopt_part = paraoptset('Mutation.Name', 'mutint', 'Mutation.Range', 0.1)
        The structure paraopt_part contains just the fields 'Mutation.Name'
        and 'Mutation.Range' set to the specified values.

  paraopt = paraoptset(paraoptold, 'name1', value1, ...) 
     Alters an existing paraoptions structure paraoptold using the given
     properties.
     paraopt_new = paraoptset(paraopt_part, 'Recombination.Name', 'recdis', Mutation.Name', 'mutreal')
        The structure paraopt_part defined in the previous example is extended 
        with the property 'Recombination.Name'. The property 'Mutation.Name' 
        is set to a new value.

  paraopt = paraoptset(paraoptold, paraoptnew) 
     Combines an existing paraoptions structure paraoptold with a new 
     paraoptions structure paraoptnew. Any new properties overwrite 
     corresponding old properties.
     paraopt_all = paraoptset(paraoptset, paraopt_new)
        The full and default structure returned by paraoptset (see second 
        example above) is redefined with the properties from paraopt_new, 
        which was preset in the examples above.

  paraopt = paraoptset(paraoptcheck)
     When called with just one paraoptions 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: paraoptprint

Cross-Reference Information