refactor!: remove pure-function API, engine is RPN-only#15
Merged
Conversation
BREAKING CHANGE: The engine package no longer exports pure functions. All math (FV, PV, PMT, NPV, IRR, DepSL, DepSOYD, DepDB, Amort, BondPrice, BondYield, SolveTVM, Rate, NPer, Timing, End, Begin, NaNf64, ErrNoConvergence, ErrNoSolution, MaxDigits) is now package-private. SetN/SetI/SetPV/SetPMT/SetFV now take a value argument instead of reading from the X register. Migration: e.X = 360; e.SetN() → e.SetN(360) e.X = 5; e.SetI() → e.SetI(5) - Unexport all math functions; Engine methods delegate internally - Parameterize SetN/SetI/SetPV/SetPMT/SetFV with value arguments - Rename finance.go -> math.go for clarity - Delete finance_example_test.go (pure-function examples) - Convert examples/ to Engine RPN usage - Remove Functional API section from README
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Breaking Change
The engine package no longer exports pure functions. All math is now package-private and accessed through the Engine struct's RPN methods. SetN/SetI/SetPV/SetPMT/SetFV now take a value argument.
Removed exports
Migration
Before:
After:
Changes