Clean up the API a little #5
Open
Conversation
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
Many Ruby objects offer the ability to initialize an instance object using a block. It's a very natural Ruby idiom. Added appropriate methods to support this idiom and removed the attr_accessors. Aliased the new methods to the old methods so the original API would continue to work. Would like to deprecate this old API. Aliased shorter names for the 'calc' methods. The original method naming is a bit clunky so this cleans it up.
Removed section on Testing since there are no tests.
Rubygems now complains when no license exists, so I just chose the simple 0-clause BSD license. Really just says "use as-is at your own risk"
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.
Good library. Better foundation than the one I wrote. :)
I find the getter/setter way of initializing objects a little bit grating so I added a DSL block style initializer. Also made some aliases for the
calcmethods so it read a little more like english.If you like these changes, I may add a utility to allow for generating 30/60/90 day implied volatility calculations. See here for why: http://quant.stackexchange.com/questions/27714/how-to-compute-30-60-90-day-implied-volatility
Not sure if that utility belongs in this gem... it's fairly compact and focused. Maybe just provide some additional functions for computing forward prices.