Merge pull request #4 from bonskotti/nautilus

NAUTILUS method
industrial-optimization-group · Nov 19, 2020 · 227bc11 · 227bc11
2 parents 585333b + 3ff0c75
commit 227bc11
Show file tree

Hide file tree

Showing 11 changed files with 1,389 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -130,5 +130,6 @@ dmypy.json
 
 # other
 .vscode
+.idea
 
 sandbox.py
diff --git a/desdeo_mcdm/interactive/Nautilus.py b/desdeo_mcdm/interactive/Nautilus.py
diff --git a/desdeo_mcdm/interactive/__init__.py b/desdeo_mcdm/interactive/__init__.py
@@ -7,6 +7,14 @@
     "ENautilusInitialRequest",
     "ENautilusRequest",
     "ENautilusStopRequest",
+    "validate_response",
+    "validate_preferences",
+    "validate_n_iterations",
+    "Nautilus",
+    "NautilusException",
+    "NautilusInitialRequest",
+    "NautilusRequest",
+    "NautilusStopRequest",
     "NautilusNavigator",
     "NautilusNavigatorException",
     "NautilusNavigatorRequest",
@@ -26,6 +34,18 @@
     ENautilusRequest,
     ENautilusStopRequest,
 )
+
+from desdeo_mcdm.interactive.Nautilus import (
+    validate_response,
+    validate_preferences,
+    validate_n_iterations,
+    Nautilus,
+    NautilusException,
+    NautilusInitialRequest,
+    NautilusRequest,
+    NautilusStopRequest
+)
+
 from desdeo_mcdm.interactive.NautilusNavigator import (
     NautilusNavigator,
     NautilusNavigatorException,

diff --git a/docs/api/desdeo_mcdm.interactive.Nautilus.rst b/docs/api/desdeo_mcdm.interactive.Nautilus.rst
@@ -0,0 +1,36 @@
+Nautilus
+========
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autoclass:: Nautilus
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Nautilus.calculate_bounds
+      ~Nautilus.calculate_distance
+      ~Nautilus.calculate_iteration_point
+      ~Nautilus.calculate_preference_factors
+      ~Nautilus.handle_initial_request
+      ~Nautilus.handle_request
+      ~Nautilus.iterate
+      ~Nautilus.solve_asf
+      ~Nautilus.start
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: calculate_bounds
+   .. automethod:: calculate_distance
+   .. automethod:: calculate_iteration_point
+   .. automethod:: calculate_preference_factors
+   .. automethod:: handle_initial_request
+   .. automethod:: handle_request
+   .. automethod:: iterate
+   .. automethod:: solve_asf
+   .. automethod:: start
+
+   .. _article: https://www.sciencedirect.com/science/article/pii/S0377221710001785
+   __ article_
diff --git a/docs/api/desdeo_mcdm.interactive.NautilusException.rst b/docs/api/desdeo_mcdm.interactive.NautilusException.rst
@@ -0,0 +1,6 @@
+NautilusException
+=================
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autoexception:: NautilusException
diff --git a/docs/api/desdeo_mcdm.interactive.NautilusInitialRequest.rst b/docs/api/desdeo_mcdm.interactive.NautilusInitialRequest.rst
@@ -0,0 +1,27 @@
+NautilusInitialRequest
+======================
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autoclass:: NautilusInitialRequest
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NautilusInitialRequest.response
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~NautilusInitialRequest.init_with_method
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: response
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: init_with_method
diff --git a/docs/api/desdeo_mcdm.interactive.NautilusRequest.rst b/docs/api/desdeo_mcdm.interactive.NautilusRequest.rst
@@ -0,0 +1,17 @@
+NautilusRequest
+===============
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autoclass:: NautilusRequest
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~NautilusRequest.response
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: response
diff --git a/docs/api/desdeo_mcdm.interactive.NautilusStopRequest.rst b/docs/api/desdeo_mcdm.interactive.NautilusStopRequest.rst
@@ -0,0 +1,7 @@
+NautilusStopRequest
+===================
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autoclass:: NautilusStopRequest
+   :show-inheritance:
diff --git a/docs/api/desdeo_mcdm.interactive.validate_n_iterations.rst b/docs/api/desdeo_mcdm.interactive.validate_n_iterations.rst
@@ -0,0 +1,6 @@
+validate_n_iterations
+=====================
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autofunction:: validate_n_iterations
diff --git a/docs/api/desdeo_mcdm.interactive.validate_preferences.rst b/docs/api/desdeo_mcdm.interactive.validate_preferences.rst
@@ -0,0 +1,6 @@
+validate_preferences
+====================
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autofunction:: validate_preferences
diff --git a/docs/api/desdeo_mcdm.interactive.validate_response.rst b/docs/api/desdeo_mcdm.interactive.validate_response.rst
@@ -0,0 +1,6 @@
+validate_response
+=================
+
+.. currentmodule:: desdeo_mcdm.interactive
+
+.. autofunction:: validate_response