2. Installation.

The VecMat software consists of the following files.
vec_mat.h

This includes the necessary library files, and then includes all of the other header files except "vm_fftw.h" and "random.h".

vector.h

This header file defines the Vector class, the Vector<T>::iterator class, and the Vector<T>::const_iterator class.

matrix.h

This header file defines the Matrix<T> class.

vm_math.h

This header file provides overloaded operators for vectors and matrices, and also provides overloaded math functions.

vm_io.h

This header file provides overloaded streaming IO operators for vectors and matrices, as well as support functions for reading and writing binary data to and from files.

vm_tools.h

This header file provides several support functions and function objects for use with vectors and matrices.

vm_types.h

This header file provides typedef declarations for commonly used vector and matrix types.

vm_traits.h

This header file provides numeric traits for extracting useful information about various types. It is used by several of the other header files.

vm_fftw.h

This header file provides wrappers for using the FFTW software with vectors.

random.h

This header file provides several pseudorandom number generators.

vm_math.cpp

This source file is included by the "vm_math.h" header file.

vm_io.cpp

This source file is included by the "vm_io.h"header file.

vm_tools.cpp

This source file is included by the "vm_tools.h" header file.

To install this software, create a subdirectory in a directory your compiler recognizes as an include directory, called "vm". Place all of the files included in this archive in this directory. To use the software, include the file "vm/vec_mat.h" in your source files.

The "vec_mat.h" header file includes all of the necessary files for basic functionality. The "random.h" and "vm_fftw.h" header files must be included separately, and the "random.h" header file can be used independently of the rest of the software, if you wish.

Next Section

Back to Index