linearAlgebra.h

00001 /* This file is part of the Palabos library.
00002  *
00003  * Copyright (C) 2011 FlowKit Sarl
00004  * Avenue de Chailly 23
00005  * 1012 Lausanne, Switzerland
00006  * E-mail contact: contact@flowkit.com
00007  *
00008  * The most recent release of Palabos can be downloaded at 
00009  * <http://www.palabos.org/>
00010  *
00011  * The library Palabos is free software: you can redistribute it and/or
00012  * modify it under the terms of the GNU Affero General Public License as
00013  * published by the Free Software Foundation, either version 3 of the
00014  * License, or (at your option) any later version.
00015  *
00016  * The library is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Affero General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU Affero General Public License
00022  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
00023 */
00024 
00025 #ifndef LINEAR_ALGEBRA_H
00026 #define LINEAR_ALGEBRA_H
00027 
00028 #include "core/globalDefs.h"
00029 #include "core/array.h"
00030 
00031 namespace plb {
00032 
00033 // Compute two 3D unit vectors v2Unit and v3Unit that are orthogonal to a given unit
00034 //   vector v1Unit and to each other.
00035 //   ATTENTION: it is a prerequisite that the input vector v1Unit is unitary. If you
00036 //   have a non-unitary vector v1, you should provide v1/norm(v1) as argument.
00037 template<typename T>
00038 void gramSchmidt(Array<T,3> const& v1Unit, Array<T,3>& v2Unit, Array<T,3>& v3Unit);
00039 
00040 } // namespace plb
00041 
00042 #endif  // LINEAR_ALGEBRA_H
00043