|
Last change
on this file since 88bb6b was 750cff, checked in by Frederik Heber <heber@…>, 14 years ago |
|
HUGE: Update on documenation.
- a general skeleton of the documentation is now in place with all the major
components of MoleCuilder explained to some extent.
- some information has been transfered from TRAC (e.g. install procecure) into
this doxygen documentation where it is general and not specific to the
situation at our institute.
|
-
Property mode
set to
100644
|
|
File size:
836 bytes
|
| Line | |
|---|
| 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2010 University of Bonn. All rights reserved.
|
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * \file linearalgebra.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Oct 31, 2011
|
|---|
| 12 | * Author: heber
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 | /**
|
|---|
| 16 | * \page linearalgebra Linear Algebra submodule
|
|---|
| 17 | *
|
|---|
| 18 | * The Linear Algebra submodule wraps GSL functionality into C++ classes. It
|
|---|
| 19 | * has its own documentation residing in the subfolder \b LinearAlgebra.
|
|---|
| 20 | *
|
|---|
| 21 | * Most important are the Vector and Matrix classes including operators to
|
|---|
| 22 | * allow for easy algebra, e.g.
|
|---|
| 23 | * \code
|
|---|
| 24 | * Vector test(1,1,1);
|
|---|
| 25 | * Matrix m(3,3);
|
|---|
| 26 | * m.setIdentity();
|
|---|
| 27 | * std::cout << "Vector " << test << " times the identity is " << test*m M << std::endl;
|
|---|
| 28 | * \endcode
|
|---|
| 29 | *
|
|---|
| 30 | *
|
|---|
| 31 | * \date 2011-10-31
|
|---|
| 32 | *
|
|---|
| 33 | */
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
