Refactor derivative operator creation with factory function #115
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor Derivative Operator Creation
This pull request introduces a significant refactor to the way derivative operators are created within the
vampyr
Python interface. A new factory function namedDerivative
has been added to simplify the creation process and provide a more intuitive interface for users.Usage Instructions:
To create a derivative operator, you can now use the
Derivative
function with the desired type as a string argument. Here are the possible types and their corresponding operator configurations:"center"
: Creates an ABGVOperator with parameters (0.5, 0.5)"simple"
: Creates an ABGVOperator with parameters (0.0, 0.0)"forward"
: Creates an ABGVOperator with parameters (0.0, 1.0)"backward"
: Creates an ABGVOperator with parameters (1.0, 0.0)"b-spline"
: Creates a BSOperator with a specified order (default is 1)"ph"
: Creates a PHOperator with a specified order (default is 1)Here's an example of how to use the new interface: