From 8114da3da3249ca6f372bf9257e40b239ad92d12 Mon Sep 17 00:00:00 2001
From: Bas Nijholt <basnijholt@gmail.com>
Date: Wed, 6 Sep 2017 11:35:33 +0200
Subject: [PATCH] improve docstrings of Learner2D
---
adaptive/learner.py | 27 ++++++++++-----------------
1 file changed, 10 insertions(+), 17 deletions(-)
diff --git a/adaptive/learner.py b/adaptive/learner.py
index f72158d0..191a8f1c 100644
--- a/adaptive/learner.py
+++ b/adaptive/learner.py
@@ -489,8 +489,7 @@ class BalancingLearner(BaseLearner):
def _max_disagreement_location_in_simplex(points, values, grad, transform):
- """
- Find the point of maximum disagreement between linear and quadratic model
+ """Find the point of maximum disagreement between linear and quadratic model
Parameters
----------
@@ -589,35 +588,29 @@ def _max_disagreement_location_in_simplex(points, values, grad, transform):
class Learner2D(BaseLearner):
- """
- Sample a 2-D function adaptively.
+ """Sample a 2-D function adaptively.
Parameters
----------
+ function : callable
+ The function to learn. Must take a tuple of two real
+ parameters and return a real number.
bounds : list of 2-tuples
A list ``[(a1, b1), (a2, b2)]`` containing bounds,
one per dimension.
dtype : dtype, optional
Type of data from function. Default: float (real-valued)
- Methods
- -------
- sample
- Add new samples obtained from a function.
- add
- Add a new sample point. Use in combination with `next()`.
- next
- Return next sampling point.
-
Attributes
----------
points
- Sample points so far.
+ Sample points so far including the unknown interpolated ones.
values
+ Sampled values so far including the unknown interpolated ones.
+ points_real
+ Sample points so far.
+ values_real
Sampled values so far.
- integral
- Estimate for the N-dim integral over the bounded area,
- based on an interpolant constructed from the samples.
Notes
-----
--
GitLab