Merge pull request #59 from issp-center-dev/develop

merge develop into master

.gitignore

@@ -1,3 +1,7 @@
+output
+output_*
+work
+
 ### https://raw.github.com/github/gitignore/ec246076319913acee4aaeef8caf86b78e586e7a/Python.gitignore
 
 # Byte-compiled / optimized / DLL files

README.md

@@ -12,7 +12,7 @@ In the future, we plan to add other direct problem solvers and search algorithms
 | Branch |                Build status                 |                                       Documentation                                       |
 | :----: | :-----------------------------------------: | :---------------------------------------------------------------------------------------: |
 | [master][source/master] (latest) | [![master][ci/master/badge]][ci/master/uri] |        [![doc_en][doc/en/badge]][doc/en/uri] [![doc_ja][doc/ja/badge]][doc/ja/uri]        |
-| [v2.1.0][source/stable] (latest stable) |                     --                      | [![doc_en][doc/en/badge]][doc/stable/en/uri] [![doc_ja][doc/ja/badge]][doc/stable/ja/uri] |
+| [v2.2.0][source/stable] (latest stable) |                     --                      | [![doc_en][doc/en/badge]][doc/stable/en/uri] [![doc_ja][doc/ja/badge]][doc/stable/ja/uri] |
 
 ## py2dmat
 
@@ -98,12 +98,12 @@ author = {Yuichi Motoyama and Kazuyoshi Yoshimi and Izumi Mochizuki and Harumich
 This software was developed with the support of "*Project for advancement of software usability in materials science*" of The Institute for Solid State Physics, The University of Tokyo.
 
 [source/master]: https://github.com/issp-center-dev/2DMAT/
-[source/stable]: https://github.com/issp-center-dev/2DMAT/tree/v2.1.0
+[source/stable]: https://github.com/issp-center-dev/2DMAT/tree/v2.2.0
 [ci/master/badge]: https://github.com/issp-center-dev/2DMAT/workflows/Test/badge.svg?branch=master
 [ci/master/uri]: https://github.com/issp-center-dev/2DMAT/actions?query=branch%3Amaster
 [doc/en/badge]: https://img.shields.io/badge/doc-English-blue.svg
 [doc/en/uri]: https://issp-center-dev.github.io/2DMAT/manual/master/en/index.html
 [doc/ja/badge]: https://img.shields.io/badge/doc-Japanese-blue.svg
 [doc/ja/uri]: https://issp-center-dev.github.io/2DMAT/manual/master/ja/index.html
-[doc/stable/en/uri]: https://issp-center-dev.github.io/2DMAT/manual/v2.1.0/en/index.html
-[doc/stable/ja/uri]: https://issp-center-dev.github.io/2DMAT/manual/v2.1.0/ja/index.html
+[doc/stable/en/uri]: https://issp-center-dev.github.io/2DMAT/manual/v2.2.0/en/index.html
+[doc/stable/ja/uri]: https://issp-center-dev.github.io/2DMAT/manual/v2.2.0/ja/index.html

doc/en/source/algorithm/mapper_mpi.rst

@@ -58,9 +58,10 @@ Mesh definition file
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Define the grid space to be explored in this file.
-The first column is the index of the mesh, and the second and subsequent columns are the values of variables defined in ``string_list`` in the ``[solver.param]`` section.
+1 + ``dimension`` columns are required.
+The first column is the index of the mesh, and the second and subsequent columns are the values of parameter.
 
-Below, a sample file is shown.
+A sample file for two dimensions is shown below.
 
 .. code-block::
 

doc/en/source/conf.py

@@ -57,7 +57,7 @@
 # The short X.Y version.
 version = u'2.2'
 # The full version, including alpha/beta/rc tags.
-release = u'2.2-dev'
+release = u'2.2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/en/source/input.rst

@@ -24,6 +24,10 @@ The input file consists of the following six sections.
 
   - Define the mapping from a parameter searched by ``Algorithm`` .
 
+- ``limitation``
+
+  - Define the limitation (constration) of parameter searched by ``Algorithm`` .
+
 - ``log``
 
   - Specify parameters related to logging of solver calls.
@@ -157,6 +161,52 @@ mean
   \end{matrix}
   \right).
 
+
+[``limitation``] section
+*************************
+
+This section defines the limitation (constraint) in an :math:`N` dimensional parameter searched by ``Algorithm``, :math:`x`, in addition of ``min_list`` and ``max_list``.
+
+In the current version, a linear inequation with the form :math:`Ax+b>0` is available.
+
+- ``co_a``
+
+  Format: List of list of float, or a string (default: ``[]``)
+
+  Description: :math:`N \times M` matrix :math:`A`. An empty list ``[]`` is a shorthand of an identity matrix.
+               If you want to set it by a string, arrange the elements of the matrix separated with spaces and newlines (see the example).
+
+
+- ``co_b``
+
+  Format: List of float, or a string (default: ``[]``)
+
+  Description: :math:`M` dimensional vector :math:`b`. An empty list ``[]`` is a shorthand of a zero vector.
+               If you want to set it by a string, arrange the elements of the vector separated with spaces.
+
+For example, both ::
+
+  A = [[1,1], [0,1]]
+
+and ::
+
+  A = """
+  1 1
+  0 1
+  """
+
+mean
+
+.. math::
+
+  A = \left(
+  \begin{matrix}
+  1 & 1 \\
+  0 & 1
+  \end{matrix}
+  \right).
+
+
 [``log``] section
 ************************