Skip to content
Snippets Groups Projects
Commit 1449ed05 authored by Laura Christine Kühle's avatar Laura Christine Kühle
Browse files

Improved docstring for Quadrature class.

parent f196af66
No related branches found
No related tags found
No related merge requests found
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
""" """Module for quadrature.
@author: Laura C. Kühle @author: Laura C. Kühle
""" """
...@@ -26,8 +27,9 @@ class Quadrature(ABC): ...@@ -26,8 +27,9 @@ class Quadrature(ABC):
Weights used for approximation calculation. Weights used for approximation calculation.
""" """
def __init__(self, config):
"""Initializes Quadrature. def __init__(self, config: dict) -> None:
"""Initialize Quadrature.
Parameters Parameters
---------- ----------
...@@ -37,8 +39,8 @@ class Quadrature(ABC): ...@@ -37,8 +39,8 @@ class Quadrature(ABC):
""" """
self._reset(config) self._reset(config)
def _reset(self, config): def _reset(self, config: dict) -> None:
"""Resets instance variables. """Reset instance variables.
Parameters Parameters
---------- ----------
...@@ -57,17 +59,17 @@ class Quadrature(ABC): ...@@ -57,17 +59,17 @@ class Quadrature(ABC):
@property @property
def num_nodes(self) -> str: def num_nodes(self) -> str:
"""Returns number of nodes (evaluation points).""" """Return number of nodes."""
return self._num_nodes return self._num_nodes
@property @property
def nodes(self) -> ndarray: def nodes(self) -> ndarray:
"""Returns nodes (evaluation points).""" """Return nodes."""
return self._nodes return self._nodes
@property @property
def weights(self) -> ndarray: def weights(self) -> ndarray:
"""Returns evaluation weights.""" """Return evaluation weights."""
return self._weights return self._weights
...@@ -86,8 +88,9 @@ class Gauss(Quadrature): ...@@ -86,8 +88,9 @@ class Gauss(Quadrature):
Weights used for approximation calculation. Weights used for approximation calculation.
""" """
def _reset(self, config):
"""Resets instance variables. def _reset(self, config: dict) -> None:
"""Reset instance variables.
Parameters Parameters
---------- ----------
...@@ -103,6 +106,6 @@ class Gauss(Quadrature): ...@@ -103,6 +106,6 @@ class Gauss(Quadrature):
self._nodes, self._weights = leg.leggauss(self._num_nodes) self._nodes, self._weights = leg.leggauss(self._num_nodes)
@property @property
def name(self): def name(self) -> str:
"""Returns string of class name.""" """Return string of class name."""
return self.__class__.__name__ + str(self._num_nodes) return self.__class__.__name__ + str(self._num_nodes)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment