Code refactoring

[screx]

Refactoring the code will allow users to easily use, read, and contribute to the
codebase more effectively!

rewrite parts of code to become more readable, modular, and usability if possible while
keeping functionality the exact same. i.e. public method function signatures remain the exact
same but their internals are modified to reflect our goals

These are just some suggestions I have after looking through the code, feel free to add others or discuss ideas for this

Ideas:

• clean up comments

• removal of unused bits of code

• move default options in the function header

  • currently options are being passed in and compared to default options in the
    function body
  • factory-like methods
  • e.g. evaluate(...) based on options[“method”] should call a new
    function that returns the same ADT
  • move default parameters to function header
  • can be used with functions that use a specific set of parameters that
    are always included.
  • use of **kwargs instead of default passing in options
  • https://stackoverflow.com/questions/1769403/what-is-the-purpose-and
  • use-of-kwargs

• verbosity passed in the options of each method instead of set as a class attribute

  • perhaps setting the objects default attribute to change this and if say the
    objects verbosity is set to false you can pass the verbose argument to set it to
    true for ONLY that method

• rewrite input verification

  • currently being done by also keeping dict of parameter set along with
    anonymous functions that perform input verification
  • use getter/setter functions?
    • set an attribute and verify the type and value o/w throw an error or something
    • get the attribute value after its set

• use of static methods or new classes

  • from what I’ve seen a lot of the methods do not actually use any of the
    classes attributes other than num_params/param_list/symbolics_boolean
  • consider using some sort of design pattern to help with this

• better testing suite

  • currently tests/ is full of stubbed tests!

• examples/

  • unify all steps into 1 larger jupyter notebook OR create readme’s that describe
    the logical order of reading the jupyter notebooks and what the examples are
    accomplishing