ScaMaC  0.8.2
A Scalable Matrix Collection
scamac_vector.h
Go to the documentation of this file.
1 
8 #ifndef SCAMAC_VECTOR_H
9 #define SCAMAC_VECTOR_H
10 
11 #include "scamac_inttypes.h"
12 #include "scamac_defs.h"
13 #include "scamac_error.h"
14 #include <stdbool.h>
15 #include <complex.h>
16 
17 /* abstract objects */
18 typedef struct scamac_vector_st ScamacVector;
19 typedef struct scamac_vectormem_st ScamacVectorMem;
20 
23 ScamacErrorCode scamac_vecmat_init();
26 ScamacErrorCode scamac_vecmat_finalize();
27 
33 ScamacErrorCode scamac_vectormem_alloc(ScamacInt nv, int m, ScamacValType valtype, ScamacVectorMem ** v);
37 ScamacErrorCode scamac_vectormem_free(ScamacVectorMem * v);
38 
43 ScamacErrorCode scamac_vector_view (ScamacVectorMem * vm, ScamacVector ** v);
47 ScamacErrorCode scamac_vector_view_single(ScamacVectorMem * vm, int i, ScamacVector ** v);
48 ScamacErrorCode scamac_vector_view_range (ScamacVectorMem * vm, int ia, int ib, ScamacVector ** v);
49 ScamacErrorCode scamac_vector_view_mask (ScamacVectorMem * vm, const bool *mask, ScamacVector ** v);
50 
54 ScamacErrorCode scamac_vector_free(ScamacVector * v);
55 
56  ScamacInt scamac_vector_query_nv (const ScamacVector * v);
57  int scamac_vector_query_m (const ScamacVector * v);
58 // int scamac_vector_query_max_m (const ScamacVector * v);
59 ScamacValType scamac_vector_query_valtype(const ScamacVector * v);
60 
61 
69 ScamacErrorCode scamac_vector_sub_single (const ScamacVector * v, int i, ScamacVector ** w);
70 ScamacErrorCode scamac_vector_sub_range (const ScamacVector * v, int ia, int ib, ScamacVector ** w);
71 ScamacErrorCode scamac_vector_sub_mask (const ScamacVector * v, const bool *mask, ScamacVector ** w);
75 ScamacErrorCode scamac_vector_complement(const ScamacVector * v, ScamacVector ** w);
76 
77 
81 ScamacErrorCode scamac_vector_align(ScamacVector * v);
82 ScamacErrorCode scamac_vector_align_front(ScamacVector * v);
83 
84 
85 
86 /* +++++ +++++ +++++ operations +++++ +++++ +++++ */
87 
88 ScamacErrorCode scamac_vector_zero (ScamacVector * v);
89 //ScamacErrorCode scamac_vector_random(int seed, ScamacVector * v);
90 ScamacErrorCode scamac_vector_random(const char * seed, bool use_entropy, bool normalize, ScamacVector * v);
91 
96 ScamacErrorCode scamac_vector_assign(const char *which, ScamacVector * v);
97 
102 ScamacErrorCode scamac_vector_copy (const ScamacVector * v, ScamacVector * w);
103 
104 
109 ScamacErrorCode scamac_vector_dot (const ScamacVector * v1, const ScamacVector * v2, double * dot);
110 ScamacErrorCode scamac_vector_zdot(const ScamacVector * v1, const ScamacVector * v2, double complex * zdot);
111 
115 ScamacErrorCode scamac_vector_nrm2 (const ScamacVector * v, double * nrm);
116 
123 ScamacErrorCode scamac_vector_dotmatrix (const ScamacVector * v1, const ScamacVector * v2, double * dotm);
124 ScamacErrorCode scamac_vector_zdotmatrix(const ScamacVector * v1, const ScamacVector * v2, double complex * zdotm);
125 
136 ScamacErrorCode scamac_vector_gram (const ScamacVector * v, double * gram);
137 ScamacErrorCode scamac_vector_zgram(const ScamacVector * v, double complex * zgram);
138 
139 
143 ScamacErrorCode scamac_mvector_axpby (const ScamacVector * x, ScamacVector * y, const double *a, const double *b);
144 ScamacErrorCode scamac_mvector_zaxpby(const ScamacVector * x, ScamacVector * y, const double complex *a, const double complex *b);
145 ScamacErrorCode scamac_svector_axpby (const ScamacVector * x, ScamacVector * y, double a, double b);
146 ScamacErrorCode scamac_svector_zaxpby(const ScamacVector * x, ScamacVector * y, double complex a, double complex b);
147 
151 ScamacErrorCode scamac_mvector_scal (ScamacVector * x, const double * s);
152 ScamacErrorCode scamac_mvector_zscal(ScamacVector * x, const double complex * s);
153 ScamacErrorCode scamac_svector_scal (ScamacVector * x, double s);
154 ScamacErrorCode scamac_svector_zscal(ScamacVector * x, double complex s);
155 
162 ScamacErrorCode scamac_vector_transform (const ScamacVector * x, const double * a, ScamacVector * y);
163 ScamacErrorCode scamac_vector_ztransform(const ScamacVector * x, const double complex * a, ScamacVector * y);
164 
165 
180 ScamacErrorCode scamac_vector_orthogonalize (const ScamacVector * v, ScamacVector * w, double * r, int * p);
181 ScamacErrorCode scamac_vector_zorthogonalize(const ScamacVector * v, ScamacVector * w, double complex * r, int * p);
182 
183 
184 ScamacErrorCode scamac_vector_check_orthogonality(const ScamacVector * v, double * err, double * errnrm, double * errperp);
185 
186 
187 ScamacErrorCode scamac_vector_print(const ScamacVector * v);
188 
189 /* internal use, mainly */
190 
191 
192 bool scamac_vectormem_check(const ScamacVectorMem * vm);
193 bool scamac_vector_check(const ScamacVector * v);
194 bool scamac_vector_check_compatibility(const ScamacVector * v1, const ScamacVector * v2);
195 bool scamac_vector_check_compatible_columns(const ScamacVector * v1, const ScamacVector * v2);
196 bool scamac_vector_check_exclusivity (const ScamacVector * v1, const ScamacVector * v2);
197 bool scamac_vector_check_aligned (const ScamacVector * v);
198 void * scamac_vector_getptr(const ScamacVector * v, ScamacInt i);
199 
200 
201 /* +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ */
202 /* obsolete */
203 /* +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ +++ */
204 
208 /* ScamacErrorCode scamac_vector_lincomb (const ScamacVector * x, const double * a, ScamacVector * y); */
209 /* ScamacErrorCode scamac_vector_zlincomb(const ScamacVector * x, const double complex * a, ScamacVector * y); */
210 
218 /* ScamacErrorCode scamac_vector_project (const ScamacVector * vm, ScamacVector * v, double * c, double * d); */
219 /* ScamacErrorCode scamac_vector_zproject(const ScamacVector * vm, ScamacVector * v, double complex * c, double complex * d); */
220 
221 
222 #endif /* SCAMAC_VECTOR_H */
scamac_defs.h
basic ScaMaC definitions
scamac_vector_align
ScamacErrorCode scamac_vector_align(ScamacVector *v)
scamac_inttypes.h
ScaMaC index/integer types.
scamac_vectormem_free
ScamacErrorCode scamac_vectormem_free(ScamacVectorMem *v)
scamac_vectormem_alloc
ScamacErrorCode scamac_vectormem_alloc(ScamacInt nv, int m, ScamacValType valtype, ScamacVectorMem **v)
Allocate vector(s)equivalent to calling scamac_vector_multiple_alloc with m=1.
scamac_vector_copy
ScamacErrorCode scamac_vector_copy(const ScamacVector *v, ScamacVector *w)
scamac_vector_dot
ScamacErrorCode scamac_vector_dot(const ScamacVector *v1, const ScamacVector *v2, double *dot)
scamac_vector_dotmatrix
ScamacErrorCode scamac_vector_dotmatrix(const ScamacVector *v1, const ScamacVector *v2, double *dotm)
scamac_vector_complement
ScamacErrorCode scamac_vector_complement(const ScamacVector *v, ScamacVector **w)
scamac_mvector_scal
ScamacErrorCode scamac_mvector_scal(ScamacVector *x, const double *s)
scamac_vector_sub_single
ScamacErrorCode scamac_vector_sub_single(const ScamacVector *v, int i, ScamacVector **w)
scamac_mvector_axpby
ScamacErrorCode scamac_mvector_axpby(const ScamacVector *x, ScamacVector *y, const double *a, const double *b)
scamac_vector_transform
ScamacErrorCode scamac_vector_transform(const ScamacVector *x, const double *a, ScamacVector *y)
scamac_vector_free
ScamacErrorCode scamac_vector_free(ScamacVector *v)
scamac_vector_assign
ScamacErrorCode scamac_vector_assign(const char *which, ScamacVector *v)
scamac_vector_view_single
ScamacErrorCode scamac_vector_view_single(ScamacVectorMem *vm, int i, ScamacVector **v)
scamac_error.h
ScaMaC data structure and macro definitions.
scamac_vector_gram
ScamacErrorCode scamac_vector_gram(const ScamacVector *v, double *gram)
scamac_vector_orthogonalize
ScamacErrorCode scamac_vector_orthogonalize(const ScamacVector *v, ScamacVector *w, double *r, int *p)
scamac_vector_nrm2
ScamacErrorCode scamac_vector_nrm2(const ScamacVector *v, double *nrm)
scamac_vector_view
ScamacErrorCode scamac_vector_view(ScamacVectorMem *vm, ScamacVector **v)
Generated by   doxygen 1.8.13