Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pdsp to documentation #186

Open
wants to merge 3 commits into
base: master-backup
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/api/api_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,4 @@ Procrustes API
softassign.rst
rotational.rst
symmetric.rst
psdp.rst
35 changes: 35 additions & 0 deletions doc/api/psdp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
..
: The Procrustes library provides a set of functions for transforming
: a matrix to make it as similar as possible to a target matrix.
:
: Copyright (C) 2017-2022 The QC-Devs Community
:
: This file is part of Procrustes.
:
: Procrustes is free software; you can redistribute it and/or
: modify it under the terms of the GNU General Public License
: as published by the Free Software Foundation; either version 3
: of the License, or (at your option) any later version.
:
: Procrustes is distributed in the hope that it will be useful,
: but WITHOUT ANY WARRANTY; without even the implied warranty of
: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
: GNU General Public License for more details.
:
: You should have received a copy of the GNU General Public License
: along with this program; if not, see <http://www.gnu.org/licenses/>
:
: --


.. _psdp:

:mod:`procrustes.psdp`
=============================

.. automodule:: procrustes.psdp
:members:
:undoc-members:
:special-members:
:inherited-members:
:private-members:
10 changes: 2 additions & 8 deletions doc/notebooks/Quick_Start.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -161,14 +161,8 @@
"id": "6163449e",
"metadata": {},
"source": [
"### Accessing Scaling, Translation Related Information"
]
},
{
"cell_type": "markdown",
"id": "171e4d70",
"metadata": {},
"source": [
"**Accessing Scaling, Translation Related Information**\n",
"\n",
"In order to access the scaling factor of the initial two input matrices, we can use `_scale_array` function in `utils` module."
]
},
Expand Down
2 changes: 1 addition & 1 deletion procrustes/psdp.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ def psdp_woodgate(
:math:`\mathbf{E}_i` is the answer.
- Compute :math:`\mathbf{D}_i`.
- Minimize :math:`f(\mathbf{E}_i - w_i \mathbf{D}_i)`.
- :math:`\mathbf{E}_{i + 1} = \mathbf{E}_i - w_i_min \mathbf{D}_i`
- :math:`\mathbf{E}_{i + 1} = \mathbf{E}_i - {(w_i)}_{min} \mathbf{D}_i`.
- :math:`i = i + 1`, start from 2 again.


Expand Down