|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| atlas/ | H | 03-May-2022 | - | 914 | 760 |
| doc/ | H | 03-May-2022 | - | 2,226 | 1,550 |
| m4/ | H | 31-Aug-2013 | - | 8,744 | 7,874 |
| support/ | H | 31-Aug-2013 | - | 22 | 14 |
| wfmath/ | H | 03-May-2022 | - | 16,260 | 10,107 |
| wfmath.pbproj/ | H | 31-Aug-2013 | - | 1,746 | 1,745 |
| AUTHORS | H A D | 02-Jan-2009 | 483 | 21 | 15 |
| COPYING | H A D | 02-Jan-2009 | 17.6 KiB | 341 | 281 |
| ChangeLog | H A D | 31-Aug-2013 | 67.7 KiB | 2,459 | 1,687 |
| INSTALL | H A D | 02-Jan-2009 | 7.6 KiB | 183 | 143 |
| Makefile.am | H A D | 31-Aug-2013 | 397 | 15 | 9 |
| Makefile.in | H A D | 03-May-2022 | 27.5 KiB | 864 | 770 |
| NEWS | H A D | 31-Aug-2013 | 1,016 | 53 | 26 |
| README | H A D | 02-Jan-2009 | 2.7 KiB | 63 | 50 |
| TODO | H A D | 09-Apr-2013 | 1.9 KiB | 45 | 37 |
| aclocal.m4 | H A D | 31-Aug-2013 | 36.1 KiB | 1,037 | 934 |
| autogen.sh | H A D | 21-Apr-2013 | 1.2 KiB | 56 | 44 |
| config.guess | H A D | 07-Nov-2008 | 43.8 KiB | 1,527 | 1,315 |
| config.h.in | H A D | 31-Aug-2013 | 1.7 KiB | 63 | 42 |
| config.sub | H A D | 07-Nov-2008 | 32.6 KiB | 1,659 | 1,514 |
| configure | H A D | 31-Aug-2013 | 546.9 KiB | 18,175 | 15,397 |
| configure.ac | H A D | 31-Aug-2013 | 2.3 KiB | 106 | 83 |
| depcomp | H A D | 21-Nov-2009 | 18.2 KiB | 631 | 407 |
| install-sh | H A D | 21-Nov-2009 | 13.3 KiB | 521 | 344 |
| ltmain.sh | H A D | 25-Jan-2013 | 276.9 KiB | 9,657 | 7,304 |
| mingw32-wfmath.spec.in | H A D | 19-Apr-2011 | 1.3 KiB | 55 | 45 |
| missing | H A D | 21-Nov-2009 | 11.2 KiB | 377 | 281 |
| wfmath-1.0.pc.in | H A D | 09-Apr-2013 | 229 | 11 | 9 |
| wfmath.spec | H A D | 31-Aug-2013 | 1.6 KiB | 81 | 64 |
| wfmath.spec.in | H A D | 02-Jan-2009 | 1.7 KiB | 81 | 64 |
README
1This is the Worldforge math library. It's licensed under the GPL
2(see file COPYING), and basic compilation instructions are in
3the file INSTALL. The current maintainer is Ron Steinke
4<rsteinke@w-link.net>.
5
6The primary focus of WFMath is geometric objects. Thus,
7it includes several shapes (boxes, balls, lines), in addition
8to the basic math objects that are used to build these shapes
9(points, vectors, matricies).
10
11The only library that WFMath checks for is Atlas, and it only does this
12for the sake of some test functions. The only dependency on Atlas is
13in the file atlasconv.h. This header file contains
14some inline functions which can be used to convert the various
15objects in WFMath to Atlas::Message::Object and back. This
16header file will be installed whether Atlas is present or not,
17but to use it you must of course have the Atlas headers installed.
18
19Most of the library classes can be divided into two sorts. The
20first kind are basic mathematical objects, whose members are all fundamental
21types. The second kind are shapes, which implement the shape class
22interface described in doc/shape.h. There are four classes of the first kind:
23
24Vector<> A basic mathematical vector
25RotMatrix<> An orthogonal matrix of determinant 1, useful for
26 describing rotations.
27Point<> A point in space. This basic class also implements
28 the shape interface in doc/shape.h.
29Quaternion A quaternion
30
31The shape classes are:
32
33AxisBox<> A box oriented parallel to the coordinate axes
34Ball<> Ball<2> is a circle, Ball<3> is a sphere, etc.
35Segment<> A line segment, defined by its endpoints
36RotBox<> Like AxisBox<>, but it can be rotated to arbitrary
37 angles
38Polygon<> A 2 dimensional polygon contained in a (possibly)
39 larger dimensional space
40
41The library also contains some probability-related functions,
42as well as wrappers for system time and random number functions.
43
44Anyone interested in contributing to this project should do three things:
45
461) Send me an email. This is mostly to let me know someone else is working
47 with the CVS repository, so I can be careful about merging commits.
48
492) Look at the file doc/CLASS_LAYOUT, which specifies which member functions
50 all classes should have, and what order they should appear in.
51 This only applies to significant classes, not things like
52 ColinearVectors in error.h, which is only there to be thrown as
53 as exception.
54
553) Update the ChangeLog _every_ time you commit to CVS. This makes
56 it possible for other people to have some idea what you're working on.
57
58The documentation is at this point confined to the doc/CLASS_LAYOUT file
59and comments in the code. There's also a sample shape class definition
60in the file shape.h in the doc directory. This has comments about
61what member functions all shape classes are supposed to have, and what they
62do.
63