Duffing Atttractor + docstring fix + docs

Author: TechnoTanuki

Hello_DuffingAttractor.py

@@ -0,0 +1,37 @@
+notice = """
+       Duffing Attractor Demo
+ -----------------------------------
+| Copyright 2022 by Joel C. Alcarez |
+| [joelalcarez1975@gmail.com]       |
+|-----------------------------------|
+|    We make absolutely no warranty |
+| of any kind, expressed or implied |
+|-----------------------------------|
+|   This graphics library outputs   |
+|   to a bitmap file.               |
+ -----------------------------------
+"""
+from Python_BMP.BITMAPlib import(
+    saveduffingattractor2file as f,
+    getfuncmetastr as meta)
+import subprocess as proc
+from os import path
+
+
+def main():
+        print(f'{notice}\n{meta(f)}')
+        imgedt = 'mspaint'  # replace with another editor if Unix
+        rootdir = path.dirname(__file__) #get path of running script
+        file = f'hello{f.__name__}.bmp' # random file name
+        f(file, # path to new file
+        256, 256, # size of file
+        24, # bit depth
+        0.25, 0.3, 1.0, 0.05,# constants (float)
+        20000 # number of iterations
+        )
+        print('Saved to %s in %s\nAll done close %s to finish' % \
+                (file, rootdir, imgedt)) # tell user something happened
+        ret = proc.call([imgedt, file])
+
+if __name__=="__main__":
+        main()

Python_BMP/BITMAPlib.py

@@ -314,7 +314,8 @@
     kochsnowflakevert,
     nattractorlist,
     peterdejongattractorlist,
-    symmetriciconattractorlist
+    symmetriciconattractorlist,
+    duffingattractorlist
     )
 
 from .inttools import(
@@ -12738,6 +12739,25 @@ def peterdejongattractor(
     return plotattractor(peterdejongattractorlist(a, b, c, d, n), x, y, bits)
 
 
+def duffingattractor(
+        x: int, y: int, bits: int,
+        a: float, b: float,
+        w: float, dt: float, n: int):
+    """Draws a Peter de Jong Attractor
+
+    Args:
+        x, y    : int dimensions of bmp
+        bits    : int bit depth
+        a, b, w : float coefficients
+        dt      : time interval
+        n: number of terms to compute
+
+    Returns:
+        byref unsigned byte array
+    """
+    return plotattractor(duffingattractorlist(0, 0, 0, dt, a, b, w, n), x, y, bits)
+
+
 def hopalongattractor(
         x: int, y: int, bits: int,
         a: float, b: float,
@@ -12854,6 +12874,7 @@ def saveikedaattractor2file(
     """Draws an Ikeda Attractor to file
 
     Args:
+        file      : full path to new file
         x, y      : int dimensions of bmp
         bits      : int bit depth
         a, b, k, p: float coefficients
@@ -12874,6 +12895,7 @@ def savegumowskimiraattractor2file(
     """Draws a Gumowski-Mira attractor to file
 
     Args:
+        file: full path to new file
         x, y: int dimensions of bmp
         bits: int bit depth
         ox, oy: starting coordinates
@@ -12901,6 +12923,7 @@ def savenattractor2file(
     """Draws a N Attractor to file
 
     Args:
+        file      : full path to new file
         x, y      : int dimensions of bmp
         bits      : int bit depth
         a, b, c, d: float coefficients
@@ -12921,6 +12944,7 @@ def savepeterdejongattractor2file(
     """Draws a Peter de Jong Attractor to file
 
     Args:
+        file      : full path to new file
         x, y      : int dimensions of bmp
         bits      : int bit depth
         a, b, c, d: float coefficients
@@ -12932,6 +12956,29 @@ def savepeterdejongattractor2file(
     saveBMP(file, peterdejongattractor(x, y, bits, a, b, c, d, n))
 
 
+@functimer
+def saveduffingattractor2file(
+        file: str,
+        x: int, y: int, bits: int,
+        a: float, b: float,
+        w: float, dt: float, n: int):
+    """Draws a Duffing Attractor to file
+
+    Args:
+        file   : full path to new file
+        x, y   : int dimensions of bmp
+        bits   : int bit depth
+        a, b, c: float coefficients
+        dt     : time interval
+        n: number of terms to compute
+
+
+    Returns:
+        a bitmap file
+    """
+    saveBMP(file, duffingattractor(x, y, bits, a, b, w, dt, n))
+
+
 @functimer
 def savehopalongattractor2file(
         file: str,

Python_BMP/fractals.py

@@ -2169,3 +2169,33 @@ def symmetriciconattractorlist(
              z.imag * p.imag)) * z + \
         (g * p).conjugate() - o * c * 1j
     return v
+
+
+def duffingattractorlist(
+    x: float = 0, y: float = 0, t: float = 0,
+    dt: float = 0.01,
+    a: float = 0.25 , b: float = 0.3, w: float = 1.0,
+    n: int = 25000) -> list[list[float, float]]:
+    """Returns list of [x,y] coordinate pairs for a
+    Duffing Attractor
+
+    Args:
+        x, y: float starting coordinates
+        t: float start time
+        dt: float time interval
+        a, b, w: float coefficients
+        n: number of terms to compute
+
+    Returns:
+        list of x,y pairs for a Duffing Attractor
+        [x: float, y: float]
+    """
+    v = [(0,0)] * n
+    for i in range(n):
+        dx = y * dt
+        dy = (x - x ** 3 - a  * y + b * cosine(w * t)) * dt
+        x += dx
+        y += dy
+        t += dt
+        v[i] = (x, y)
+    return v

assets/fractals/duffingattractor.bmp

@@ -1676,6 +1676,46 @@ Draws a vector (line segment with arrow head)
         byref modified unsigned byte array
 
 
+### [`duffingattractor`](#duffingattractor)
+
+```py
+def duffingattractor(x: int, y: int, bits: int, a: float, b: float, w: float, dt: float, n: int):
+```
+
+Draws a Peter de Jong Attractor
+
+    Args:
+        x, y    : int dimensions of bmp
+        bits    : int bit depth
+        a, b, w : float coefficients
+        dt      : time interval
+        n: number of terms to compute
+    
+    Returns:
+        byref unsigned byte array
+
+
+### [`duffingattractorlist`](#duffingattractorlist)
+
+```py
+def duffingattractorlist(x: float = 0, y: float = 0, t: float = 0, dt: float = 0.01, a: float = 0.25, b: float = 0.3, w: float = 1.0, n: int = 25000) -> list[list[float, float]]:
+```
+
+Returns list of [x,y] coordinate pairs for a
+Duffing Attractor
+
+    Args:
+        x, y: float starting coordinates
+        t: float start time
+        dt: float time interval
+        a, b, w: float coefficients
+        n: number of terms to compute
+    
+    Returns:
+        list of x,y pairs for a Duffing Attractor
+        [x: float, y: float]
+
+
 ### [`eggcurvevert`](#eggcurvevert)
 
 ```py
@@ -12372,6 +12412,27 @@ Saves a Cos(z) Julia Set to a file
         a bitmap file
 
 
+### [`saveduffingattractor2file`](#saveduffingattractor2file)
+
+```py
+def saveduffingattractor2file(file: str, x: int, y: int, bits: int, a: float, b: float, w: float, dt: float, n: int):
+```
+
+Draws a Duffing Attractor to file
+
+    Args:
+        file   : full path to new file
+        x, y   : int dimensions of bmp
+        bits   : int bit depth
+        a, b, c: float coefficients
+        dt     : time interval
+        n: number of terms to compute
+    
+    
+    Returns:
+        a bitmap file
+
+
 ### [`savefractal2file`](#savefractal2file)
 
 ```py
@@ -12506,6 +12567,7 @@ def savegumowskimiraattractor2file(file: str, x: int, y: int, bits: int, ox: flo
 Draws a Gumowski-Mira attractor to file
 
     Args:
+        file: full path to new file
         x, y: int dimensions of bmp
         bits: int bit depth
         ox, oy: starting coordinates
@@ -12578,6 +12640,7 @@ def saveikedaattractor2file(file: str, x: int, y: int, bits: int, a: float, b: f
 Draws an Ikeda Attractor to file
 
     Args:
+        file      : full path to new file
         x, y      : int dimensions of bmp
         bits      : int bit depth
         a, b, k, p: float coefficients
@@ -13426,6 +13489,7 @@ def savenattractor2file(file: str, x: int, y: int, bits: int, a: float, b: float
 Draws a N Attractor to file
 
     Args:
+        file      : full path to new file
         x, y      : int dimensions of bmp
         bits      : int bit depth
         a, b, c, d: float coefficients
@@ -13512,6 +13576,7 @@ def savepeterdejongattractor2file(file: str, x: int, y: int, bits: int, a: float
 Draws a Peter de Jong Attractor to file
 
     Args:
+        file      : full path to new file
         x, y      : int dimensions of bmp
         bits      : int bit depth
         a, b, c, d: float coefficients

docs/BitmapLib_Doc.md

@@ -318,6 +318,8 @@ If there is demand for it I could in theory write a book based on this project l
 
 [![cliffordattractor](../assets/fractals/cliffordattractor.bmp)](../Hello_CliffordAttractor.py)
 
+[![duffingattractor](../assets/fractals/duffingattractor.bmp)](../Hello_DuffingAttractor.py)
+
 [![fractaldream](../assets/fractals/fractaldreamattractor.bmp)](../Hello_FractalDreamAttractor.py)
 
 [![Hopalongattractor](../assets/fractals/hopalongattractor.bmp)](../Hello_HopalongAttractor.py)

docs/Hello_Graphics.md

@@ -76,6 +76,7 @@
         savehopalongattractor2file as hopalong,
         savefractaldreamattractor2file as fractaldream,
         savesymmetriciconattractor2file as symicon,
+        saveduffingattractor2file as duffing,
         palshift2file
         )
 
@@ -567,6 +568,17 @@ def testsymmetriciconattractor(self):
         self.filecmp(*p)
 
 
+    def testduffingattractor(self):
+        p = self._filepaths("duffingattractor.bmp")
+        duffing(p[0], # path to new file
+        256, 256, # size of file
+        24, # bit depth
+        0.25, 0.3, 1.0, 0.05, # constants (float)
+        20000 # number of iterations
+        )
+        self.filecmp(*p)
+
+
     def testastroid(self):
         p = self._filepaths("astroid.bmp")
         astroid(p[0], # path to new file