ObjCryst/a00268_source.html

 /*  ObjCryst++ Object-Oriented Crystallographic Library

     (c) 2000-2005 Vincent Favre-Nicolin vincefn@users.sourceforge.net

         2000-2001 University of Geneva (Switzerland)


     This program is free software; you can redistribute it and/or modify

     it under the terms of the GNU General Public License as published by

     the Free Software Foundation; either version 2 of the License, or

     (at your option) any later version.


     This program is distributed in the hope that it will be useful,

     but WITHOUT ANY WARRANTY; without even the implied warranty of

     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

     GNU General Public License for more details.


     You should have received a copy of the GNU General Public License

     along with this program; if not, write to the Free Software

     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

 // This file includes some "effectors" used to format

 //strings, numbers, some arrays...

 #ifndef _VFN_STREAM_FORMAT_H_

 #define _VFN_STREAM_FORMAT_H_


 #include <string>

 #include <iostream>

 #include <vector>


 #include "ObjCryst/CrystVector/CrystVector.h"


 class FormatInt

 {

    public:

       FormatInt(const long num,const int width=5);

       ~FormatInt();

    //private:

       const long mValue;

       const int mWidth;

 };


 std::ostream& operator<< (std::ostream& os, const FormatInt& fInt);


 class FormatFloat

 {

    public:

       FormatFloat(const REAL num,const int width=10,const int precision=4);

       ~FormatFloat();


    //private:

       const REAL mValue;

       const int mWidth;

       const int mPrecision;

 };


 std::ostream& operator<< (std::ostream& os, const FormatFloat &fFloat);


 class FormatString

 {

    public:

       FormatString(const string &str,const unsigned int width=5);

       ~FormatString();

       int length() const;

    //private:

       string mString;

       const unsigned int mWidth;

 };


 std::ostream& operator<< (std::ostream& os, const FormatString& fStr);


 template<class T> class FormatVertVector

 {

    public:

       FormatVertVector( const CrystVector<T> &fVect,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( const CrystVector<T> &fVect1,

                         const CrystVector<T> &fVect2,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( const CrystVector<T> &fVect1,

                         const CrystVector<T> &fVect2,

                         const CrystVector<T> &fVect3,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( const CrystVector<T> &fVect1,

                         const CrystVector<T> &fVect2,

                         const CrystVector<T> &fVect3,

                         const CrystVector<T> &fVect4,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( const CrystVector<T> &fVect1,

                         const CrystVector<T> &fVect2,

                         const CrystVector<T> &fVect3,

                         const CrystVector<T> &fVect4,

                         const CrystVector<T> &fVect5,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( const CrystVector<T> &fVect1,

                         const CrystVector<T> &fVect2,

                         const CrystVector<T> &fVect3,

                         const CrystVector<T> &fVect4,

                         const CrystVector<T> &fVect5,

                         const CrystVector<T> &fVect6,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( const CrystVector<T> *pVect,

                         const int nbVect,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( const CrystVector<T> &fVect1,

                         const CrystVector<T> *pVect,

                         const int nbVect,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       FormatVertVector( std::vector<const CrystVector<T> *>& v,

                         const int width=10,

                         const int precision=4,

                         const int nb=0);

       ~FormatVertVector();

       //int length() const;

    //private:

       std::vector<const CrystVector<T> *>mvpVectors;

       const int mWidth;

       const int mPrecision;

       const int mNb;

 };


 template<class T> std::ostream& operator<< (std::ostream &os, const FormatVertVector<T> &fVect);


 template<class T> class FormatHorizVector

 {

    public:

       FormatHorizVector(const CrystVector<T> &fVect,

                         const int width=10,

                         const int precision=4);

       ~FormatHorizVector();

       //int length() const;

    //private:

       const CrystVector<T> *mpVectors;

       const int mWidth;

       const int mPrecision;

 };


 template<class T> ostream& operator<< (std::ostream &os, const FormatHorizVector<T> &fVect);


 template<class T>class FormatVertVectorHKLFloats

 {

    public:

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const CrystVector<T> &o,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const CrystVector<T> &o,

                                  const CrystVector<T> &p,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const CrystVector<T> &o,

                                  const CrystVector<T> &p,

                                  const CrystVector<T> &q,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const CrystVector<T> &o,

                                  const CrystVector<T> &p,

                                  const CrystVector<T> &q,

                                  const CrystVector<T> &r,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const CrystVector<T> &o,

                                  const CrystVector<T> &p,

                                  const CrystVector<T> &q,

                                  const CrystVector<T> &r,

                                  const CrystVector<T> &s,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const CrystVector<T> &o,

                                  const CrystVector<T> &p,

                                  const CrystVector<T> &q,

                                  const CrystVector<T> &r,

                                  const CrystVector<T> &s,

                                  const CrystVector<T> &t,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( const CrystVector<T> &h,

                                  const CrystVector<T> &k,

                                  const CrystVector<T> &l,

                                  const CrystVector<T> &m,

                                  const CrystVector<T> &n,

                                  const CrystVector<T> &o,

                                  const CrystVector<T> &p,

                                  const CrystVector<T> &q,

                                  const CrystVector<T> &r,

                                  const CrystVector<T> &s,

                                  const CrystVector<T> &t,

                                  const CrystVector<T> &u,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       FormatVertVectorHKLFloats( std::vector<const CrystVector<T> *>& v,

                                  const int width=10,

                                  const int precision=4,

                                  const int nb=0);

       ~FormatVertVectorHKLFloats();

       //int length() const;

    //private:

       std::vector<const CrystVector<T> *>mvpVectors;

       const int mWidth;

       const int mPrecision;

       const int mNb;

 };


 template<class T> std::ostream& operator<< (std::ostream& os, const FormatVertVectorHKLFloats<T> &fStr);


 #endif

FormatInt
output a number as a formatted integer:
Definition: VFNStreamFormat.h:36

FormatVertVectorHKLFloats
Output vectors as column arrays, with the first 3 columns printed as integers.
Definition: VFNStreamFormat.h:188

FormatVertVector
output one or several vectors as (a) column(s):
Definition: VFNStreamFormat.h:96

FormatHorizVector
Format vector as horiz array:
Definition: VFNStreamFormat.h:168

CrystVector
Vector library (Blitz++ mimic) for ObjCryst++.
Definition: CrystVector.h:122

FormatFloat
output a number as a formatted float:
Definition: VFNStreamFormat.h:54

FormatString
output a string with a fixed length (adding necessary space or removing excess characters) : ...
Definition: VFNStreamFormat.h:73