Skip to content

Commit

Permalink
Update integrand doc in promol
Browse files Browse the repository at this point in the history
  • Loading branch information
Ali-Tehrani committed Aug 5, 2020
1 parent 4d56f35 commit 187c00e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ def get_readme():
"scipy>=1.4",
"importlib_resources",
"sympy",
"dataclass; python_version < '3.7'",
"dataclasses; python_version < '3.7'",
],
)
16 changes: 8 additions & 8 deletions src/grid/protransform.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,19 @@ class CubicProTransform(Grid):
Methods
-------
integrate(trick=False)
Integral of a real-valued function over Euclidean space.
Integral of a real-valued function over Euclidean space. Can use promolecular trick.
jacobian()
Jacobian of the transformation from Real space to Theta space :math:`[-1, 1]^3`.
hessian()
Hessian of the transformation from Real space to Theta space :math:`[-1, 1]^3`.
steepest_ascent_theta()
Direction of steepest-ascent of a function in theta space from gradient in real space.
transform():
Transform Real point to theta point :math:`[-1, 1]^3`.
Transform Real point to Theta space :math:`[-1, 1]^3`.
inverse(bracket=(-10, 10))
Transform theta point to Real space :math:`\mathbb{R}^3`.
Transform Theta point to Real space :math:`\mathbb{R}^3`.
interpolate_function(use_log=False, nu=0)
Interpolate a function (or its derivative) at a real point.
Interpolate a function (or its logarithm) at a real point. Can interpolate its derivative.
Examples
--------
Expand Down Expand Up @@ -242,9 +242,9 @@ def inverse(self, theta_pt, bracket=(-10, 10)):

def integrate(self, *value_arrays, trick=False, tol=1e-10):
r"""
Integrate any real-valued function :math:`f: \mathbb{R}^3 \rightarrow \mathbb{R}`.
Integrate any real-valued function on Euclidean space.
Assumes integrand decays faster than the promolecular density.
Assumes the function decays faster than the promolecular density.
Parameters
----------
Expand All @@ -271,7 +271,7 @@ def integrate(self, *value_arrays, trick=False, tol=1e-10):
Notes
-----
- Formula for the integration of a integrable function
:math:`f : \mathbb{R}^3 \rightarrow \mathbb{R}` is done as follows:
:math:`f : \mathbb{R}^3 \rightarrow \mathbb{R}` is done as follows:
.. math::
\int \int \int f(x, y, z)dxdy dz \approx
Expand All @@ -280,7 +280,7 @@ def integrate(self, *value_arrays, trick=False, tol=1e-10):
\text{where } N = \int \int \int \rho^o(x, y, z) dx dy dz.
- This method assumes the integrand decays faster than the promolecular density.
- This method assumes function f decays faster than the promolecular density.
"""
promolecular = self.promol.promolecular(self.points)
Expand Down

0 comments on commit 187c00e

Please sign in to comment.