From 11fc50e9f68b8cee32c3c27cf079172c7b6a3d10 Mon Sep 17 00:00:00 2001
From: Simon Bjurek <simbj106@student.liu.se>
Date: Tue, 28 Jan 2025 12:40:25 +0100
Subject: [PATCH] added docstrings
---
b_asic/sfg_generators.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/b_asic/sfg_generators.py b/b_asic/sfg_generators.py
index 789cd161..998c20a8 100644
--- a/b_asic/sfg_generators.py
+++ b/b_asic/sfg_generators.py
@@ -264,6 +264,7 @@ def direct_form_1_iir(
mult_properties: Optional[Union[Dict[str, int], Dict[str, Dict[str, int]]]] = None,
add_properties: Optional[Union[Dict[str, int], Dict[str, Dict[str, int]]]] = None,
) -> SFG:
+ """Generates a direct-form IIR filter of type I with coefficients a and b."""
if len(a) != len(b):
raise ValueError("size of coefficient lists a and b are not the same")
if name is None:
@@ -318,6 +319,7 @@ def direct_form_2_iir(
mult_properties: Optional[Union[Dict[str, int], Dict[str, Dict[str, int]]]] = None,
add_properties: Optional[Union[Dict[str, int], Dict[str, Dict[str, int]]]] = None,
) -> SFG:
+ """Generates a direct-form IIR filter of type II with coefficients a and b."""
if len(a) != len(b):
raise ValueError("size of coefficient lists a and b are not the same")
if name is None:
--
GitLab