Skip to content

Commit ef3110c

Browse files
Merge pull request #32 from LilithHafner/patch-1
2 parents e78dee9 + e6b1869 commit ef3110c

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,10 @@ There are security implications for integer overflow in certain situations.
5555

5656
- This package is designed for easy use and written to be performant in many sorts of use.
5757

58-
- All exported types are stable (e.g. `typeof(SafeInt32 + 1) == SafeInt32`)
58+
- All exported types are stable (e.g. `typeof(SafeInt32(1) + 1) == SafeInt32`)
5959

6060
- Using _SaferIntegers_ can preclude some known ways that insecure systems are breached.
6161

62-
- Safer Rationals just work: `SafeRational(161803398875,100000000000)`
63-
6462
### Test code for integer safety
6563

6664
- `@saferintegers include(joinpath("PackageTestDirectory", "PackageTests.jl"))`
@@ -103,7 +101,6 @@ should a calculation encouter an overflow or underflow,
103101
- `abs`, `neg`, `div`, `fld`, `fld1`, `cld`, `rem`, `mod`, `mod1`
104102
- `divrem`, `fldmod`, `fldmod1`
105103
- `-`, `+`, `*`, `^`
106-
- so does `/`, before converting to Float64
107104

108105
## Exported Types and Constructors / Converters
109106

@@ -127,9 +124,9 @@ const SafeInteger = Union{SafeUnsigned, SafeSigned}
127124

128125
## Other Conversions
129126

130-
`Signed(x::SafeSigned)` returns an signed integer of the same bitwidth as x
131-
`Unsigned(x::SafeUnsigned)` returns an unsigned integer of the same bitwidth as x
132-
`Integer(x::SafeInteger)` returns an Integer of the same bitwidth and either Signed or Unsigned as is x
127+
`Signed(x::SafeSigned)` returns an signed built-in integer of the same bitwidth as x
128+
`Unsigned(x::SafeUnsigned)` returns an unsigned built-in integer of the same bitwidth as x
129+
`Integer(x::SafeInteger)` returns a built-in integer of the same bitwidth and either Signed or Unsigned as is x
133130

134131
`SafeSigned(x::Signed)` returns a safe signed integer of the same bitwidth as x
135132
`SafeUnsigned(x::Unsigned)` returns a safe unsigned integer of the same bitwidth as x

0 commit comments

Comments
 (0)