/usr/include/nvector/nvector_serial.h is in libsundials-serial-dev 2.5.0-3+b3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | /*
* -----------------------------------------------------------------
* $Revision: 1.2 $
* $Date: 2006/11/29 00:05:07 $
* -----------------------------------------------------------------
* Programmer(s): Scott D. Cohen, Alan C. Hindmarsh, Radu Serban,
* and Aaron Collier @ LLNL
* -----------------------------------------------------------------
* Copyright (c) 2002, The Regents of the University of California.
* Produced at the Lawrence Livermore National Laboratory.
* All rights reserved.
* For details, see the LICENSE file.
* -----------------------------------------------------------------
* This is the header file for the serial implementation of the
* NVECTOR module.
*
* Part I contains declarations specific to the serial
* implementation of the supplied NVECTOR module.
*
* Part II defines accessor macros that allow the user to
* efficiently use the type N_Vector without making explicit
* references to the underlying data structure.
*
* Part III contains the prototype for the constructor N_VNew_Serial
* as well as implementation-specific prototypes for various useful
* vector operations.
*
* Notes:
*
* - The definition of the generic N_Vector structure can be found
* in the header file sundials_nvector.h.
*
* - The definition of the type 'realtype' can be found in the
* header file sundials_types.h, and it may be changed (at the
* configuration stage) according to the user's needs.
* The sundials_types.h file also contains the definition
* for the type 'booleantype'.
*
* - N_Vector arguments to arithmetic vector operations need not
* be distinct. For example, the following call:
*
* N_VLinearSum_Serial(a,x,b,y,y);
*
* (which stores the result of the operation a*x+b*y in y)
* is legal.
* -----------------------------------------------------------------
*/
#ifndef _NVECTOR_SERIAL_H
#define _NVECTOR_SERIAL_H
#ifdef __cplusplus /* wrapper to enable C++ usage */
extern "C" {
#endif
#include <sundials/sundials_nvector.h>
/*
* -----------------------------------------------------------------
* PART I: SERIAL implementation of N_Vector
* -----------------------------------------------------------------
*/
/* serial implementation of the N_Vector 'content' structure
contains the length of the vector, a pointer to an array
of 'realtype' components, and a flag indicating ownership of
the data */
struct _N_VectorContent_Serial {
long int length;
booleantype own_data;
realtype *data;
};
typedef struct _N_VectorContent_Serial *N_VectorContent_Serial;
/*
* -----------------------------------------------------------------
* PART II: macros NV_CONTENT_S, NV_DATA_S, NV_OWN_DATA_S,
* NV_LENGTH_S, and NV_Ith_S
* -----------------------------------------------------------------
* In the descriptions below, the following user declarations
* are assumed:
*
* N_Vector v;
* long int i;
*
* (1) NV_CONTENT_S
*
* This routines gives access to the contents of the serial
* vector N_Vector.
*
* The assignment v_cont = NV_CONTENT_S(v) sets v_cont to be
* a pointer to the serial N_Vector content structure.
*
* (2) NV_DATA_S NV_OWN_DATA_S and NV_LENGTH_S
*
* These routines give access to the individual parts of
* the content structure of a serial N_Vector.
*
* The assignment v_data = NV_DATA_S(v) sets v_data to be
* a pointer to the first component of v. The assignment
* NV_DATA_S(v) = data_V sets the component array of v to
* be data_v by storing the pointer data_v.
*
* The assignment v_len = NV_LENGTH_S(v) sets v_len to be
* the length of v. The call NV_LENGTH_S(v) = len_v sets
* the length of v to be len_v.
*
* (3) NV_Ith_S
*
* In the following description, the components of an
* N_Vector are numbered 0..n-1, where n is the length of v.
*
* The assignment r = NV_Ith_S(v,i) sets r to be the value of
* the ith component of v. The assignment NV_Ith_S(v,i) = r
* sets the value of the ith component of v to be r.
*
* Note: When looping over the components of an N_Vector v, it is
* more efficient to first obtain the component array via
* v_data = NV_DATA_S(v) and then access v_data[i] within the
* loop than it is to use NV_Ith_S(v,i) within the loop.
* -----------------------------------------------------------------
*/
#define NV_CONTENT_S(v) ( (N_VectorContent_Serial)(v->content) )
#define NV_LENGTH_S(v) ( NV_CONTENT_S(v)->length )
#define NV_OWN_DATA_S(v) ( NV_CONTENT_S(v)->own_data )
#define NV_DATA_S(v) ( NV_CONTENT_S(v)->data )
#define NV_Ith_S(v,i) ( NV_DATA_S(v)[i] )
/*
* -----------------------------------------------------------------
* PART III: functions exported by nvector_serial
*
* CONSTRUCTORS:
* N_VNew_Serial
* N_VNewEmpty_Serial
* N_VMake_Serial
* N_VCloneVectorArray_Serial
* N_VCloneVectorArrayEmpty_Serial
* DESTRUCTORS:
* N_VDestroy_Serial
* N_VDestroyVectorArray_Serial
* OTHER:
* N_VPrint_Serial
* -----------------------------------------------------------------
*/
/*
* -----------------------------------------------------------------
* Function : N_VNew_Serial
* -----------------------------------------------------------------
* This function creates and allocates memory for a serial vector.
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT N_Vector N_VNew_Serial(long int vec_length);
/*
* -----------------------------------------------------------------
* Function : N_VNewEmpty_Serial
* -----------------------------------------------------------------
* This function creates a new serial N_Vector with an empty (NULL)
* data array.
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT N_Vector N_VNewEmpty_Serial(long int vec_length);
/*
* -----------------------------------------------------------------
* Function : N_VMake_Serial
* -----------------------------------------------------------------
* This function creates and allocates memory for a serial vector
* with a user-supplied data array.
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT N_Vector N_VMake_Serial(long int vec_length, realtype *v_data);
/*
* -----------------------------------------------------------------
* Function : N_VCloneVectorArray_Serial
* -----------------------------------------------------------------
* This function creates an array of 'count' SERIAL vectors by
* cloning a given vector w.
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT N_Vector *N_VCloneVectorArray_Serial(int count, N_Vector w);
/*
* -----------------------------------------------------------------
* Function : N_VCloneVectorArrayEmpty_Serial
* -----------------------------------------------------------------
* This function creates an array of 'count' SERIAL vectors each
* with an empty (NULL) data array by cloning w.
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT N_Vector *N_VCloneVectorArrayEmpty_Serial(int count, N_Vector w);
/*
* -----------------------------------------------------------------
* Function : N_VDestroyVectorArray_Serial
* -----------------------------------------------------------------
* This function frees an array of SERIAL vectors created with
* N_VCloneVectorArray_Serial or N_VCloneVectorArrayEmpty_Serial.
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT void N_VDestroyVectorArray_Serial(N_Vector *vs, int count);
/*
* -----------------------------------------------------------------
* Function : N_VPrint_Serial
* -----------------------------------------------------------------
* This function prints the content of a serial vector to stdout.
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT void N_VPrint_Serial(N_Vector v);
/*
* -----------------------------------------------------------------
* serial implementations of various useful vector operations
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT N_Vector N_VCloneEmpty_Serial(N_Vector w);
SUNDIALS_EXPORT N_Vector N_VClone_Serial(N_Vector w);
SUNDIALS_EXPORT void N_VDestroy_Serial(N_Vector v);
SUNDIALS_EXPORT void N_VSpace_Serial(N_Vector v, long int *lrw, long int *liw);
SUNDIALS_EXPORT realtype *N_VGetArrayPointer_Serial(N_Vector v);
SUNDIALS_EXPORT void N_VSetArrayPointer_Serial(realtype *v_data, N_Vector v);
SUNDIALS_EXPORT void N_VLinearSum_Serial(realtype a, N_Vector x, realtype b, N_Vector y, N_Vector z);
SUNDIALS_EXPORT void N_VConst_Serial(realtype c, N_Vector z);
SUNDIALS_EXPORT void N_VProd_Serial(N_Vector x, N_Vector y, N_Vector z);
SUNDIALS_EXPORT void N_VDiv_Serial(N_Vector x, N_Vector y, N_Vector z);
SUNDIALS_EXPORT void N_VScale_Serial(realtype c, N_Vector x, N_Vector z);
SUNDIALS_EXPORT void N_VAbs_Serial(N_Vector x, N_Vector z);
SUNDIALS_EXPORT void N_VInv_Serial(N_Vector x, N_Vector z);
SUNDIALS_EXPORT void N_VAddConst_Serial(N_Vector x, realtype b, N_Vector z);
SUNDIALS_EXPORT realtype N_VDotProd_Serial(N_Vector x, N_Vector y);
SUNDIALS_EXPORT realtype N_VMaxNorm_Serial(N_Vector x);
SUNDIALS_EXPORT realtype N_VWrmsNorm_Serial(N_Vector x, N_Vector w);
SUNDIALS_EXPORT realtype N_VWrmsNormMask_Serial(N_Vector x, N_Vector w, N_Vector id);
SUNDIALS_EXPORT realtype N_VMin_Serial(N_Vector x);
SUNDIALS_EXPORT realtype N_VWL2Norm_Serial(N_Vector x, N_Vector w);
SUNDIALS_EXPORT realtype N_VL1Norm_Serial(N_Vector x);
SUNDIALS_EXPORT void N_VCompare_Serial(realtype c, N_Vector x, N_Vector z);
SUNDIALS_EXPORT booleantype N_VInvTest_Serial(N_Vector x, N_Vector z);
SUNDIALS_EXPORT booleantype N_VConstrMask_Serial(N_Vector c, N_Vector x, N_Vector m);
SUNDIALS_EXPORT realtype N_VMinQuotient_Serial(N_Vector num, N_Vector denom);
#ifdef __cplusplus
}
#endif
#endif
|