Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
- add cmp api
- add neg api
- add abs api
- add cmp helpers
  • Loading branch information
defunctzombie committed May 2, 2012
1 parent 8f7f029 commit 399410a
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Besides the **int** function, all of the other methods operate on the objects re
### int (value) ###
> construct a new aribtrary precision integer
> valid values are intergers, or strings, anything after a decimal point will be discarded
> valid values are native numbers, strings, or int objects. Anything after a decimal point will be discarded
### add (value) ###
> add {value} to our number and return a new int
Expand All @@ -51,3 +51,32 @@ Besides the **int** function, all of the other methods operate on the objects re
### mod (value) ###
> mod our int by {value} and return the new int
### neg ###
> return a new int that is the negative
### abs ###
> return a new int that is the absolute value
### cmp (value) ###
> compare our value to {value}
> return 0 if self and value are equal, -1 if self < value, 1 if self > value
### lt (value) ###
> return true if self < value
### lte (value) ###
> return true if self <= value
### gt (value) ###
> return true if self > value
### gte (value) ###
> return true if self >= value
### eq (value) ###
> return true if self == value
### ne (value) ###
> return true if self != value

0 comments on commit 399410a

Please sign in to comment.