Interface documentation using doxygen

Toggle Background

Change to the directory where you have extracted the file NormalOrder.tgz and run doxygen³. This will produce a detailed documentation of the interfaces of our classes. Afterwards point your browser locally to doxy/html/index.html or use the following link and play around with the documentation.

Finally we make the following observations:

• If you know about second quantization and C++ it should be very easy for you to understand the interface and the usage of our objects. This is typical for a well done object design.
• Our objects Product, Sum, Kronecker, SQOperator are all very simple and elementary. They are straighforwardly assembled to a Term providing the method to calculate the normal ordering. Based on the simple elementary objects the implementation of the normal ordering rather easy. This observation is common: "If you have well design objects the implementation is trivial"⁴

• Think of a comparable implementation with FORTRAN. This will not be very funny...

Unfortunately, object design is not always that easy.

Footnotes

...doxygen³

We assume that you have doxygen installed on your system.

... trivial"⁴

Bjarne Stroustrup