From bd355098cc344d2c440b4481455091bbfeac56c4 Mon Sep 17 00:00:00 2001 From: raj_mathe Date: Fri, 1 Jul 2022 22:29:58 +0200 Subject: [PATCH] master > master: code py - docs generated --- .../docs/commands/Models/CommandGenetic.md | 10 ++++++++++ .../docs/commands/Models/CommandPollard.md | 1 + .../docs/commands/Models/CommandRandomWalk.md | 16 ++++++++++++++++ .../commands/Models/DataTypeLandscapeGeometry.md | 11 +++++++++++ .../Models/DataTypeLandscapeNeighbourhoods.md | 10 ++++++++++ .../commands/Models/DataTypeLandscapeValues.md | 8 ++++++++ .../docs/commands/Models/EnumLandscapeMetric.md | 8 ++++++++ .../commands/Models/EnumPollardGrowthRate.md | 8 ++++++++ code/python/docs/commands/Models/EnumWalkMode.md | 8 ++++++++ code/python/docs/commands/README.md | 8 ++++++++ code/python/docs/config/Models/AppOptions.md | 2 ++ 11 files changed, 90 insertions(+) create mode 100644 code/python/docs/commands/Models/CommandGenetic.md create mode 100644 code/python/docs/commands/Models/CommandRandomWalk.md create mode 100644 code/python/docs/commands/Models/DataTypeLandscapeGeometry.md create mode 100644 code/python/docs/commands/Models/DataTypeLandscapeNeighbourhoods.md create mode 100644 code/python/docs/commands/Models/DataTypeLandscapeValues.md create mode 100644 code/python/docs/commands/Models/EnumLandscapeMetric.md create mode 100644 code/python/docs/commands/Models/EnumPollardGrowthRate.md create mode 100644 code/python/docs/commands/Models/EnumWalkMode.md diff --git a/code/python/docs/commands/Models/CommandGenetic.md b/code/python/docs/commands/Models/CommandGenetic.md new file mode 100644 index 0000000..c6704f3 --- /dev/null +++ b/code/python/docs/commands/Models/CommandGenetic.md @@ -0,0 +1,10 @@ +# CommandGenetic +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null] +**population** | [**List**](array.md) | | [default to null] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/Models/CommandPollard.md b/code/python/docs/commands/Models/CommandPollard.md index 8541020..c2c05f8 100644 --- a/code/python/docs/commands/Models/CommandPollard.md +++ b/code/python/docs/commands/Models/CommandPollard.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null] **number** | [**Integer**](integer.md) | | [default to null] +**growth** | [**EnumPollardGrowthRate**](EnumPollardGrowthRate.md) | | [default to null] **xMinusinit** | [**Integer**](integer.md) | | [optional] [default to 2] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/code/python/docs/commands/Models/CommandRandomWalk.md b/code/python/docs/commands/Models/CommandRandomWalk.md new file mode 100644 index 0000000..37ae052 --- /dev/null +++ b/code/python/docs/commands/Models/CommandRandomWalk.md @@ -0,0 +1,16 @@ +# CommandRandomWalk +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null] +**algorithm** | [**EnumWalkMode**](EnumWalkMode.md) | | [default to null] +**landscape** | [**DataTypeLandscapeGeometry**](DataTypeLandscapeGeometry.md) | | [default to null] +**optimise** | [**EnumOptimiseMode**](EnumOptimiseMode.md) | | [default to null] +**coordsMinusinit** | [**List**](integer.md) | Initial co-ordinates to start the algorithm. | [optional] [default to null] +**temperatureMinusinit** | [**Float**](float.md) | | [optional] [default to null] +**annealing** | [**Boolean**](boolean.md) | | [optional] [default to false] +**oneMinusbased** | [**Boolean**](boolean.md) | | [optional] [default to false] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/Models/DataTypeLandscapeGeometry.md b/code/python/docs/commands/Models/DataTypeLandscapeGeometry.md new file mode 100644 index 0000000..37de64c --- /dev/null +++ b/code/python/docs/commands/Models/DataTypeLandscapeGeometry.md @@ -0,0 +1,11 @@ +# DataTypeLandscapeGeometry +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**neighbourhoods** | [**DataTypeLandscapeNeighbourhoods**](DataTypeLandscapeNeighbourhoods.md) | | [default to null] +**labels** | [**List**](string.md) | | [default to null] +**values** | [**DataTypeLandscapeValues**](DataTypeLandscapeValues.md) | | [default to null] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/Models/DataTypeLandscapeNeighbourhoods.md b/code/python/docs/commands/Models/DataTypeLandscapeNeighbourhoods.md new file mode 100644 index 0000000..db1f3e0 --- /dev/null +++ b/code/python/docs/commands/Models/DataTypeLandscapeNeighbourhoods.md @@ -0,0 +1,10 @@ +# DataTypeLandscapeNeighbourhoods +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**radius** | [**BigDecimal**](number.md) | | [optional] [default to 1] +**metric** | [**EnumLandscapeMetric**](EnumLandscapeMetric.md) | | [default to null] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/Models/DataTypeLandscapeValues.md b/code/python/docs/commands/Models/DataTypeLandscapeValues.md new file mode 100644 index 0000000..ea376fb --- /dev/null +++ b/code/python/docs/commands/Models/DataTypeLandscapeValues.md @@ -0,0 +1,8 @@ +# DataTypeLandscapeValues +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/Models/EnumLandscapeMetric.md b/code/python/docs/commands/Models/EnumLandscapeMetric.md new file mode 100644 index 0000000..0a278f2 --- /dev/null +++ b/code/python/docs/commands/Models/EnumLandscapeMetric.md @@ -0,0 +1,8 @@ +# EnumLandscapeMetric +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/Models/EnumPollardGrowthRate.md b/code/python/docs/commands/Models/EnumPollardGrowthRate.md new file mode 100644 index 0000000..49a8b36 --- /dev/null +++ b/code/python/docs/commands/Models/EnumPollardGrowthRate.md @@ -0,0 +1,8 @@ +# EnumPollardGrowthRate +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/Models/EnumWalkMode.md b/code/python/docs/commands/Models/EnumWalkMode.md new file mode 100644 index 0000000..6c2da8e --- /dev/null +++ b/code/python/docs/commands/Models/EnumWalkMode.md @@ -0,0 +1,8 @@ +# EnumWalkMode +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/code/python/docs/commands/README.md b/code/python/docs/commands/README.md index 54e7d2e..367a851 100644 --- a/code/python/docs/commands/README.md +++ b/code/python/docs/commands/README.md @@ -14,14 +14,22 @@ Class | Method | HTTP request | Description - [Command](.//Models/Command.md) - [CommandEuklid](.//Models/CommandEuklid.md) + - [CommandGenetic](.//Models/CommandGenetic.md) - [CommandHirschberg](.//Models/CommandHirschberg.md) - [CommandPollard](.//Models/CommandPollard.md) + - [CommandRandomWalk](.//Models/CommandRandomWalk.md) - [CommandRucksack](.//Models/CommandRucksack.md) - [CommandTarjan](.//Models/CommandTarjan.md) - [CommandTsp](.//Models/CommandTsp.md) + - [DataTypeLandscapeGeometry](.//Models/DataTypeLandscapeGeometry.md) + - [DataTypeLandscapeNeighbourhoods](.//Models/DataTypeLandscapeNeighbourhoods.md) + - [DataTypeLandscapeValues](.//Models/DataTypeLandscapeValues.md) - [EnumAlgorithmNames](.//Models/EnumAlgorithmNames.md) + - [EnumLandscapeMetric](.//Models/EnumLandscapeMetric.md) - [EnumOptimiseMode](.//Models/EnumOptimiseMode.md) + - [EnumPollardGrowthRate](.//Models/EnumPollardGrowthRate.md) - [EnumRucksackAlgorithm](.//Models/EnumRucksackAlgorithm.md) + - [EnumWalkMode](.//Models/EnumWalkMode.md) diff --git a/code/python/docs/config/Models/AppOptions.md b/code/python/docs/config/Models/AppOptions.md index c2b9d20..5224a84 100644 --- a/code/python/docs/config/Models/AppOptions.md +++ b/code/python/docs/config/Models/AppOptions.md @@ -9,6 +9,8 @@ Name | Type | Description | Notes **tsp** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null] **hirschberg** | [**AppOptions_hirschberg**](AppOptions_hirschberg.md) | | [default to null] **rucksack** | [**AppOptions_rucksack**](AppOptions_rucksack.md) | | [default to null] +**randomMinuswalk** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null] +**genetic** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null] **euklid** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null] **pollardMinusrho** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null]