Documentation of comploc

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

Function Synopsis

[OP1, OP2, OP3, OP4, OP5] = comploc(WhatTask, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10);

Help text

 COMPute LOCal model things of toolbox

 This function computes diverse things for the implementation
 of the local model.

 Syntax:  [OP1, OP2, OP3, OP4, OP5] = comploc(WhatTask, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10)

 Input parameters:
    WhatTask      - String containing the name of the needed computation
    P1 - P10  - Parameters needed for the specific computations

 Output parameter:
    OP1 - OP5 - Output parameters, specific for every computation

 Possible functions:
    WhatTask == 'local_neighbourhood'
       Sort/order subpopulations according objective values, return
          position of every subpopulation
       P1     - Scalar containing number of individuals
       P2     - (column) Vector containing index of center of neighbourhood
       P3     - Scalar or vector containing local dimension of structure
                   see WhatTask == 'local_dimension'
       P4     - Scalar containing local structure
                        0: ring or cross or the same in higher dimensions,
                           only one index is different from zero
                        1: star or the same in higher dimensions
                           all indices are smaller than LocalDistance
                        2: schiefer star or the same in higher dimensions
                           the sum of all indices are smaller than LocalDistance*Dimension
                        8: all neighbours with distance smaller than LocalDistance
                        9: as many neighbours as defined in LocalDistance
                    >= 10: half structure of (local structure-10)
       P5     - Scalar containing local distance
       OP1    - Indices of individuals, one row per neighbourhood

    WhatTask == 'local_dimension'
       Compute full values for LocalDimension and check everything
       P1     - Scalar containing number of dimensions or
                vector containing length of every dimension
                if 0 or empty
       P2     - Number of individuals in population
       OP1    - Vector containing length of every dimension
                   Dimension can be computed by length(LocalDim)

    WhatTask == 'local_allneighbourindex'
       Compute all indices of all possible neighbours and their
          (squared) distance
       P1     - Scalar or vector containing dimension of structure
                   see 'local_dimension'
       P2     - maximal distance to neighbours (>=1)
       OP1    - Vector containing all possible square distances
                   sorted in a row vector
       OP2    - Matrix containing indices of neighbours corresponding
                   with distances; as many rows as dimensions and as 
                   many columns as possible neighbours

 See also: compdiv, sellocal, reinsloc

Cross-Reference Information