1 /* 2 This defines the abstract vector component. These are patterned 3 after the Level-1 Blas, but with some additions that have proved 4 useful. These include routines to allocate and free vectors. 5 6 Note that the routines that are normally thought of as returning a 7 value (e.g., dot, norm) return their value through an argument. 8 This allows these routines to be used with other datatype, such 9 as float and dcomplex. 10 11 All vectors should be declared as a Vec. All vector routines begin 12 with Vec. 13 14 15 */ 16 17 #ifndef __VEC_PACKAGE 18 #define __VEC_PACKAGE 19 #include "is.h" 20 21 #define VEC_COOKIE 0x101010 22 23 typedef struct _Vec* Vec; 24 typedef struct _VecScatterCtx* VecScatterCtx; 25 26 extern int VecCreateSequential(int,Vec *); 27 extern int VecCreateSequentialBLAS(int,Vec *); 28 29 extern int VecCreateMPI(MPI_Comm,int,int,Vec *); 30 extern int VecCreateMPIBLAS(MPI_Comm,int,int,Vec *); 31 32 extern int VecCreateInitialVector(int,Vec *); 33 34 extern int VecDot(Vec, Vec, Scalar*); 35 extern int VecTDot(Vec, Vec, Scalar*); 36 extern int VecMDot(int, Vec ,Vec*,Scalar*); 37 extern int VecMTDot(int, Vec ,Vec*,Scalar*); 38 extern int VecNorm(Vec, double*); 39 extern int VecASum(Vec, double*); 40 extern int VecMax(Vec, int *, Scalar*); 41 extern int VecScale(Scalar*, Vec); 42 extern int VecCopy(Vec, Vec); 43 extern int VecSet(Scalar*, Vec); 44 extern int VecSwap(Vec, Vec); 45 extern int VecAXPY(Scalar*, Vec, Vec); 46 extern int VecMAXPY(int, Scalar*, Vec ,Vec*); 47 extern int VecAYPX(Scalar*, Vec, Vec); 48 extern int VecWAXPY(Scalar*, Vec, Vec, Vec); 49 extern int VecPMult(Vec, Vec, Vec); 50 extern int VecPDiv(Vec, Vec, Vec); 51 extern int VecCreate(Vec,Vec *); 52 extern int VecDestroy(Vec); 53 extern int VecGetVecs(Vec, int,Vec **); 54 extern int VecFreeVecs(Vec*,int); 55 56 typedef enum {NotSetValues, InsertValues, AddValues} InsertMode; 57 58 extern int VecSetValues(Vec, int, int *,Scalar*,InsertMode); 59 extern int VecBeginAssembly(Vec); 60 extern int VecEndAssembly(Vec); 61 62 #define ScatterDown 0 63 #define ScatterUp 1 64 #define ScatterAll 2 65 extern int VecScatterBegin(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx); 66 extern int VecScatterEnd(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx); 67 extern int VecScatterCtxCreate(Vec,IS,Vec,IS,VecScatterCtx *); 68 extern int VecScatterCtxDestroy(VecScatterCtx); 69 extern int VecScatterCtxCopy(VecScatterCtx,VecScatterCtx *); 70 71 #define PipelineDown 0 72 #define PipelineUp 1 73 extern int VecPipelineBegin(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx); 74 extern int VecPipelineEnd(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx); 75 76 extern int VecGetArray(Vec,Scalar**); 77 extern int VecValidVector(Vec); 78 extern int VecView(Vec, Viewer); 79 80 extern int VecGetSize(Vec,int *); 81 extern int VecGetLocalSize(Vec,int *); 82 extern int VecGetOwnershipRange(Vec,int*,int*); 83 84 /* utility routines */ 85 extern int VecReciprocal(Vec); 86 87 #endif 88 89 90