LA_library/la_traits.h

234 lines
9.0 KiB
C
Raw Normal View History

2008-02-26 14:55:23 +01:00
/*
LA: linear algebra C++ interface library
Copyright (C) 2008 Jiri Pittner <jiri.pittner@jh-inst.cas.cz> or <jiri@pittnerovi.com>
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 3 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, see <http://www.gnu.org/licenses/>.
*/
2004-03-17 04:07:21 +01:00
////////////////////////////////////////////////////////////////////////////
2005-02-18 23:08:15 +01:00
//LA traits classes and generally needed includes
2004-03-17 04:07:21 +01:00
#ifndef _LA_TRAITS_INCL
#define _LA_TRAITS_INCL
2005-02-18 23:08:15 +01:00
using namespace std;
#include <stdio.h>
#include <string.h>
#include <iostream>
#include <complex>
#include "laerror.h"
2005-09-06 17:55:07 +02:00
#ifdef NONCBLAS
#include "noncblas.h"
#else
2005-02-18 23:08:15 +01:00
extern "C" {
#include "cblas.h"
}
2005-09-06 17:55:07 +02:00
#endif
2005-02-18 23:08:15 +01:00
2005-02-14 01:10:07 +01:00
//forward declarations
template<typename C> class NRVec;
template<typename C> class NRMat;
2006-09-18 23:46:45 +02:00
template<typename C> class NRMat_from1;
2005-02-14 01:10:07 +01:00
template<typename C> class NRSMat;
2006-09-18 23:46:45 +02:00
template<typename C> class NRSMat_from1;
2005-02-14 01:10:07 +01:00
template<typename C> class SparseMat;
2006-04-01 14:58:57 +02:00
//for general sortable classes
template<typename T, typename I, int type> struct LA_sort_traits;
template<typename T, typename I>
struct LA_sort_traits<T,I,0>
{
static inline bool compare(T object, I i, I j) {return object.bigger(i,j);};
};
template<typename T, typename I>
struct LA_sort_traits<T,I,1>
{
static inline bool compare(T object, I i, I j) {return object.smaller(i,j);};
};
2006-04-01 06:48:01 +02:00
//we will need to treat char and unsigned char as numbers in << and >> I/O operators
template<typename C>
struct LA_traits_io
{
typedef C IOtype;
};
template<>
struct LA_traits_io<char>
{
typedef int IOtype;
};
template<>
struct LA_traits_io<unsigned char>
{
typedef unsigned int IOtype;
};
2005-02-14 01:10:07 +01:00
//let's do some simple template metaprogramming and preprocessing
//to keep the thing general and compact
2008-11-26 14:30:30 +01:00
class scalar_false {};
class scalar_true {};
2005-02-14 01:10:07 +01:00
//default is non-scalar
template<typename C>
2005-12-08 13:06:23 +01:00
class isscalar { public: typedef scalar_false scalar_type;};
2005-02-14 01:10:07 +01:00
//specializations
#define SCALAR(X) \
2005-11-20 14:46:00 +01:00
template<>\
2005-12-08 13:06:23 +01:00
class isscalar<X> {public: typedef scalar_true scalar_type;};
2005-02-14 01:10:07 +01:00
//declare what is scalar
SCALAR(char)
SCALAR(short)
SCALAR(int)
SCALAR(long)
SCALAR(long long)
SCALAR(unsigned char)
SCALAR(unsigned short)
SCALAR(unsigned int)
SCALAR(unsigned long)
SCALAR(unsigned long long)
SCALAR(float)
SCALAR(double)
SCALAR(complex<float>)
SCALAR(complex<double>)
SCALAR(void *)
#undef SCALAR
//now declare the traits for scalars and for composed classes
2005-09-06 17:55:07 +02:00
//NOTE! methods in traits classes have to be declared static,
//since the class itself is never instantiated.
//for performance, it can be also inlined at the same time
2005-02-14 01:10:07 +01:00
template<typename C, typename Scalar> struct LA_traits_aux {};
2005-09-06 17:55:07 +02:00
//TRAITS SPECIALIZATIONS
2005-02-14 01:10:07 +01:00
//complex scalars
template<typename C>
struct LA_traits_aux<complex<C>, scalar_true> {
typedef complex<C> elementtype;
typedef complex<C> producttype;
typedef C normtype;
2005-09-06 17:55:07 +02:00
static inline bool gencmp(const complex<C> *x, const complex<C> *y, int n) {return memcmp(x,y,n*sizeof(complex<C>));}
static bool bigger(const complex<C> &x, const complex<C> &y) {laerror("complex comparison undefined"); return false;}
static bool smaller(const complex<C> &x, const complex<C> &y) {laerror("complex comparison undefined"); return false;}
static inline normtype norm (const complex<C> &x) {return abs(x);}
static inline void axpy (complex<C> &s, const complex<C> &x, const complex<C> &c) {s+=x*c;}
2005-09-11 22:04:24 +02:00
static inline void get(int fd, complex<C> &x, bool dimensions=0, bool transp=0) {if(sizeof(complex<C>)!=read(fd,&x,sizeof(complex<C>))) laerror("read error");}
static inline void put(int fd, const complex<C> &x, bool dimensions=0, bool transp=0) {if(sizeof(complex<C>)!=write(fd,&x,sizeof(complex<C>))) laerror("write error");}
2005-02-14 01:10:07 +01:00
static void multiget(unsigned int n,int fd, complex<C> *x, bool dimensions=0){if((ssize_t)(n*sizeof(complex<C>))!=read(fd,x,n*sizeof(complex<C>))) laerror("read error");}
static void multiput(unsigned int n, int fd, const complex<C> *x, bool dimensions=0) {if((ssize_t)(n*sizeof(complex<C>))!=write(fd,x,n*sizeof(complex<C>))) laerror("write error");}
2006-04-01 06:48:01 +02:00
static void copy(complex<C> *dest, complex<C> *src, unsigned int n) {memcpy(dest,src,n*sizeof(complex<C>));}
2006-04-09 23:07:54 +02:00
static void clear(complex<C> *dest, unsigned int n) {memset(dest,0,n*sizeof(complex<C>));}
2007-11-29 14:52:31 +01:00
static void copyonwrite(complex<C> &x) {};
2005-02-14 01:10:07 +01:00
};
//non-complex scalars
template<typename C>
struct LA_traits_aux<C, scalar_true> {
2004-03-17 04:07:21 +01:00
typedef C elementtype;
typedef C producttype;
2005-02-14 01:10:07 +01:00
typedef C normtype;
2005-09-06 17:55:07 +02:00
static inline bool gencmp(const C *x, const C *y, int n) {return memcmp(x,y,n*sizeof(C));}
static inline bool bigger(const C &x, const C &y) {return x>y;}
static inline bool smaller(const C &x, const C &y) {return x<y;}
static inline normtype norm (const C &x) {return abs(x);}
static inline void axpy (C &s, const C &x, const C &c) {s+=x*c;}
2005-09-11 22:04:24 +02:00
static inline void put(int fd, const C &x, bool dimensions=0, bool transp=0) {if(sizeof(C)!=write(fd,&x,sizeof(C))) laerror("write error");}
static inline void get(int fd, C &x, bool dimensions=0, bool transp=0) {if(sizeof(C)!=read(fd,&x,sizeof(C))) laerror("read error");}
2005-02-14 01:10:07 +01:00
static void multiput(unsigned int n,int fd, const C *x, bool dimensions=0){if((ssize_t)(n*sizeof(C))!=write(fd,x,n*sizeof(C))) laerror("write error");}
static void multiget(unsigned int n, int fd, C *x, bool dimensions=0) {if((ssize_t)(n*sizeof(C))!=read(fd,x,n*sizeof(C))) laerror("read error");}
2006-04-01 06:48:01 +02:00
static void copy(C *dest, C *src, unsigned int n) {memcpy(dest,src,n*sizeof(C));}
2006-04-09 23:07:54 +02:00
static void clear(C *dest, unsigned int n) {memset(dest,0,n*sizeof(C));}
2007-11-29 14:52:31 +01:00
static void copyonwrite(C &x) {};
2004-03-17 04:07:21 +01:00
};
2005-09-06 17:55:07 +02:00
//non-scalars except smat
2005-02-14 01:10:07 +01:00
template<typename C>
struct LA_traits; //forward declaration needed for template recursion
#define generate_traits(X) \
template<typename C> \
struct LA_traits_aux<X<C>, scalar_false> { \
typedef C elementtype; \
typedef X<C> producttype; \
typedef typename LA_traits<C>::normtype normtype; \
2005-09-06 17:55:07 +02:00
static bool gencmp(const C *x, const C *y, int n) {for(int i=0; i<n; ++i) if(x[i]!=y[i]) return true; return false;} \
static inline bool bigger(const C &x, const C &y) {return x>y;} \
static inline bool smaller(const C &x, const C &y) {return x<y;} \
static inline normtype norm (const X<C> &x) {return x.norm();} \
static inline void axpy (X<C>&s, const X<C> &x, const C c) {s.axpy(c,x);} \
2005-09-11 22:04:24 +02:00
static void put(int fd, const C &x, bool dimensions=1, bool transp=0) {x.put(fd,dimensions,transp);} \
static void get(int fd, C &x, bool dimensions=1, bool transp=0) {x.get(fd,dimensions,transp);} \
2005-02-14 01:10:07 +01:00
static void multiput(unsigned int n,int fd, const C *x, bool dimensions=1) {for(unsigned int i=0; i<n; ++i) x[i].put(fd,dimensions);} \
static void multiget(unsigned int n,int fd, C *x, bool dimensions=1) {for(unsigned int i=0; i<n; ++i) x[i].get(fd,dimensions);} \
2006-04-01 06:48:01 +02:00
static void copy(C *dest, C *src, unsigned int n) {for(unsigned int i=0; i<n; ++i) dest[i]=src[i];} \
2006-04-10 18:08:42 +02:00
static void clear(C *dest, unsigned int n) {for(unsigned int i=0; i<n; ++i) dest[i].clear();}\
2007-11-29 14:52:31 +01:00
static void copyonwrite(X<C> &x) {x.copyonwrite();}\
2004-03-17 04:07:21 +01:00
};
2005-02-14 01:10:07 +01:00
//non-scalar types defined in this library
generate_traits(NRMat)
2006-09-18 23:46:45 +02:00
generate_traits(NRMat_from1)
2005-02-14 01:10:07 +01:00
generate_traits(NRVec)
generate_traits(SparseMat)
#undef generate_traits
2005-09-06 17:55:07 +02:00
//smat
2006-09-18 23:46:45 +02:00
#define generate_traits_smat(X) \
template<typename C> \
struct LA_traits_aux<X<C>, scalar_false> { \
typedef C elementtype; \
typedef NRMat<C> producttype; \
typedef typename LA_traits<C>::normtype normtype; \
static bool gencmp(const C *x, const C *y, int n) {for(int i=0; i<n; ++i) if(x[i]!=y[i]) return true; return false;} \
static inline bool bigger(const C &x, const C &y) {return x>y;} \
static inline bool smaller(const C &x, const C &y) {return x<y;} \
static inline normtype norm (const X<C> &x) {return x.norm();} \
static inline void axpy (X<C>&s, const X<C> &x, const C c) {s.axpy(c,x);} \
static void put(int fd, const C &x, bool dimensions=1, bool transp=0) {x.put(fd,dimensions);} \
static void get(int fd, C &x, bool dimensions=1, bool transp=0) {x.get(fd,dimensions);} \
static void multiput(unsigned int n,int fd, const C *x, bool dimensions=1) {for(unsigned int i=0; i<n; ++i) x[i].put(fd,dimensions);} \
static void multiget(unsigned int n,int fd, C *x, bool dimensions=1) {for(unsigned int i=0; i<n; ++i) x[i].get(fd,dimensions);} \
static void copy(C *dest, C *src, unsigned int n) {for(unsigned int i=0; i<n; ++i) dest[i]=src[i];} \
static void clear(C *dest, unsigned int n) {for(unsigned int i=0; i<n; ++i) dest[i].clear();} \
2007-11-29 14:52:31 +01:00
static void copyonwrite(X<C> &x) {x.copyonwrite();} \
2004-03-17 04:07:21 +01:00
};
2006-09-18 23:46:45 +02:00
generate_traits_smat(NRSMat)
generate_traits_smat(NRSMat_from1)
2004-03-17 04:07:21 +01:00
2005-02-14 01:10:07 +01:00
//the final traits class
template<typename C>
struct LA_traits : LA_traits_aux<C, typename isscalar<C>::scalar_type> {};
2004-03-17 04:07:21 +01:00
#endif