Skip to content

Commit

Permalink
Added note on parameter types to ErrorMeasure and LogPDF
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelClerx committed Nov 7, 2023
1 parent 67a9786 commit 1e361ea
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion pints/_error_measures.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ class ErrorMeasure(object):
ErrorMeasures are callable objects: If ``e`` is an instance of an
:class:`ErrorMeasure` class you can calculate the error by calling ``e(p)``
where ``p`` is a point in parameter space.
where ``p`` is a point in parameter space. In PINTS, all parameters must be
continuous and real.
"""
def __call__(self, x):
raise NotImplementedError
Expand Down
3 changes: 2 additions & 1 deletion pints/_log_pdfs.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ class LogPDF(object):
All :class:`LogPDF` types are callable: when called with a vector argument
``p`` they return some value ``log(f(p))`` where ``f(p)`` is an
unnormalised PDF. The size of the argument ``p`` is given by
:meth:`n_parameters()`.
:meth:`n_parameters()`. In PINTS, all parameters must be continuous and
real.
"""
def __call__(self, x):
raise NotImplementedError
Expand Down

0 comments on commit 1e361ea

Please sign in to comment.