Skip to content

Commit

Permalink
Adding docstring for zerolikelihood
Browse files Browse the repository at this point in the history
  • Loading branch information
tsunhopang committed Aug 22, 2024
1 parent 583b759 commit cd559b6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/jimgw/single_event/likelihood.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,21 @@ def __init__(self, detectors: list[Detector], waveform: Waveform) -> None:


class ZeroLikelihood(LikelihoodBase):
"""
A likelihood class that always returns a log-likelihood of zero.
This class is primarily used for testing or debugging purposes.
Methods
-------
__init__() -> None
Initializes the ZeroLikelihood object. No parameters are required or set.
evaluate(params: dict[str, Float], data: dict) -> Float
Evaluates the likelihood for a given set of parameters and data,
always returning 0.0. This method does not perform any computation
based on the input parameters or data, making it useful for debugging.
"""

def __init__(self):
pass
Expand Down

0 comments on commit cd559b6

Please sign in to comment.