Enums#
This utility module (found in RATapi.utils.enums) contains the Enum objects
which are used under the hood to represent arguments given as string options,
such as those for control parameters or background types.
- enum RATapi.utils.enums.BackgroundActions(value)#
- Member Type:
str
Valid values are as follows:
- Add = <BackgroundActions.Add: 'add'>#
- Subtract = <BackgroundActions.Subtract: 'subtract'>#
- enum RATapi.utils.enums.BoundHandling(value)#
Defines the available options for bound handling
- Member Type:
str
Valid values are as follows:
- Off = <BoundHandling.Off: 'off'>#
- Reflect = <BoundHandling.Reflect: 'reflect'>#
- Bound = <BoundHandling.Bound: 'bound'>#
- Fold = <BoundHandling.Fold: 'fold'>#
- enum RATapi.utils.enums.Calculations(value)#
- Member Type:
str
Valid values are as follows:
- Normal = <Calculations.Normal: 'normal'>#
- Domains = <Calculations.Domains: 'domains'>#
- enum RATapi.utils.enums.Display(value)#
Defines the available options for display
- Member Type:
str
Valid values are as follows:
- Off = <Display.Off: 'off'>#
- Iter = <Display.Iter: 'iter'>#
- Notify = <Display.Notify: 'notify'>#
- Final = <Display.Final: 'final'>#
- enum RATapi.utils.enums.Geometries(value)#
- Member Type:
str
Valid values are as follows:
- AirSubstrate = <Geometries.AirSubstrate: 'air/substrate'>#
- SubstrateLiquid = <Geometries.SubstrateLiquid: 'substrate/liquid'>#
- enum RATapi.utils.enums.Hydration(value)#
- Member Type:
str
Valid values are as follows:
- None_ = <Hydration.None_: 'none'>#
- BulkIn = <Hydration.BulkIn: 'bulk in'>#
- BulkOut = <Hydration.BulkOut: 'bulk out'>#
- enum RATapi.utils.enums.Languages(value)#
- Member Type:
str
Valid values are as follows:
- Cpp = <Languages.Cpp: 'cpp'>#
- Python = <Languages.Python: 'python'>#
- Matlab = <Languages.Matlab: 'matlab'>#
- enum RATapi.utils.enums.LayerModels(value)#
- Member Type:
str
Valid values are as follows:
- CustomLayers = <LayerModels.CustomLayers: 'custom layers'>#
- CustomXY = <LayerModels.CustomXY: 'custom xy'>#
- StandardLayers = <LayerModels.StandardLayers: 'standard layers'>#
- enum RATapi.utils.enums.Parallel(value)#
Defines the available options for parallelization
- Member Type:
str
Valid values are as follows:
- Single = <Parallel.Single: 'single'>#
- Points = <Parallel.Points: 'points'>#
- Contrasts = <Parallel.Contrasts: 'contrasts'>#
- enum RATapi.utils.enums.Priors(value)#
- Member Type:
str
Valid values are as follows:
- Uniform = <Priors.Uniform: 'uniform'>#
- Gaussian = <Priors.Gaussian: 'gaussian'>#
- enum RATapi.utils.enums.Procedures(value)#
Defines the available options for procedures
- Member Type:
str
Valid values are as follows:
- Calculate = <Procedures.Calculate: 'calculate'>#
- Simplex = <Procedures.Simplex: 'simplex'>#
- DE = <Procedures.DE: 'de'>#
- NS = <Procedures.NS: 'ns'>#
- DREAM = <Procedures.DREAM: 'dream'>#
- enum RATapi.utils.enums.RATEnum(value)#
- Member Type:
str
- enum RATapi.utils.enums.Strategies(value)#
Defines the available options for differential evolution strategies
- Member Type:
str
Valid values are as follows:
- Random = <Strategies.Random: 'random'>#
- LocalToBest = <Strategies.LocalToBest: 'local to best'>#
- BestWithJitter = <Strategies.BestWithJitter: 'best jitter'>#
- RandomWithPerVectorDither = <Strategies.RandomWithPerVectorDither: 'vector dither'>#
- RandomWithPerGenerationDither = <Strategies.RandomWithPerGenerationDither: 'generation dither'>#
- RandomEitherOrAlgorithm = <Strategies.RandomEitherOrAlgorithm: 'either or'>#