AfflictionNetworks/pythagoras
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation clarification.

Browse Source
This commit is contained in:
Michael Bayne
2011-06-13 13:44:53 -07:00
parent e274c30e0e
commit 0dcc0c08e8
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -12
View File
@@ -18,25 +18,25 @@ certain design goals.
* The library is specialized on the primitive types rather than attempting to * The library is specialized on the primitive types rather than attempting to
support all types in a single class hierarchy. `pythagoras.f` and support all types in a single class hierarchy. `pythagoras.f` and
`pythagoras.d` provide essentially the same functionality using 32-bit and `pythagoras.d` provide equivalent functionality using 32-bit and 64-bit
64-bit floating point values throughout. `pythagoras.i` is specialized on int floating point values throughout. `pythagoras.i` is specialized on int and
and contains none of the curved geometry classes. It is targeted toward contains none of the curved geometry classes.
applications that need "pixel geometry".
* The library supports garbage creation avoidance for applications which are * The library supports garbage creation avoidance (for applications which are
sensitive to garbage collection pauses, like video games. For example, in sensitive to garbage collection pauses, like video games). For example, in
cases where entities return a `Rectangle` containing their bounds, a cases where entities return a `Rectangle` containing their bounds, a
corresponding method exists which accepts a `Rectangle` into which to write corresponding method exists which accepts a `Rectangle` into which to write
the bounds. the bounds. Further work is needed here, as some of the implementation
internals create garbage that could be avoided.
* The library attempts to minimize the size of its instances, by avoiding the * The library attempts to minimize the size of its instances by avoiding the
inclusion of any fields that are not essential to the function of a inclusion of any fields that are not essential to the function of a
particular geometry entity. Thus no cached hash codes or cached computed particular geometric entity. For example, no cached hash codes or cached
bounds are maintained. computed bounds are maintained.
* Helper methods associated with a given geometric primitive are separated into * Helper methods associated with a given geometric primitive are separated into
a separate utility class for that primitive. For example line-related a utility class for each primitive. For example line-related primitives are
primitives are in a class named `Lines`. in a class named `Lines`.
## License ## License