Actual source code: vecimpl.h


  2: /*
  3:    This private file should not be included in users' code.
  4:    Defines the fields shared by all vector implementations.

  6: */

  8: #ifndef __VECIMPL_H

 11: #include <petscvec.h>
 12: #include <petsc/private/petscimpl.h>

 14: PETSC_EXTERN PetscBool      VecRegisterAllCalled;
 15: PETSC_EXTERN PetscErrorCode VecRegisterAll(void);
 16: PETSC_EXTERN MPI_Op         MPIU_MAXLOC;
 17: PETSC_EXTERN MPI_Op         MPIU_MINLOC;

 19: /* ----------------------------------------------------------------------------*/

 21: typedef struct _VecOps *VecOps;
 22: struct _VecOps {
 23:   PetscErrorCode (*duplicate)(Vec, Vec *);                                          /* get single vector */
 24:   PetscErrorCode (*duplicatevecs)(Vec, PetscInt, Vec **);                           /* get array of vectors */
 25:   PetscErrorCode (*destroyvecs)(PetscInt, Vec[]);                                   /* free array of vectors */
 26:   PetscErrorCode (*dot)(Vec, Vec, PetscScalar *);                                   /* z = x^H * y */
 27:   PetscErrorCode (*mdot)(Vec, PetscInt, const Vec[], PetscScalar *);                /* z[j] = x dot y[j] */
 28:   PetscErrorCode (*norm)(Vec, NormType, PetscReal *);                               /* z = sqrt(x^H * x) */
 29:   PetscErrorCode (*tdot)(Vec, Vec, PetscScalar *);                                  /* x'*y */
 30:   PetscErrorCode (*mtdot)(Vec, PetscInt, const Vec[], PetscScalar *);               /* z[j] = x dot y[j] */
 31:   PetscErrorCode (*scale)(Vec, PetscScalar);                                        /* x = alpha * x   */
 32:   PetscErrorCode (*copy)(Vec, Vec);                                                 /* y = x */
 33:   PetscErrorCode (*set)(Vec, PetscScalar);                                          /* y = alpha  */
 34:   PetscErrorCode (*swap)(Vec, Vec);                                                 /* exchange x and y */
 35:   PetscErrorCode (*axpy)(Vec, PetscScalar, Vec);                                    /* y = y + alpha * x */
 36:   PetscErrorCode (*axpby)(Vec, PetscScalar, PetscScalar, Vec);                      /* y = alpha * x + beta * y*/
 37:   PetscErrorCode (*maxpy)(Vec, PetscInt, const PetscScalar *, Vec *);               /* y = y + alpha[j] x[j] */
 38:   PetscErrorCode (*aypx)(Vec, PetscScalar, Vec);                                    /* y = x + alpha * y */
 39:   PetscErrorCode (*waxpy)(Vec, PetscScalar, Vec, Vec);                              /* w = y + alpha * x */
 40:   PetscErrorCode (*axpbypcz)(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec); /* z = alpha * x + beta *y + gamma *z*/
 41:   PetscErrorCode (*pointwisemult)(Vec, Vec, Vec);                                   /* w = x .* y */
 42:   PetscErrorCode (*pointwisedivide)(Vec, Vec, Vec);                                 /* w = x ./ y */
 43:   PetscErrorCode (*setvalues)(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
 44:   PetscErrorCode (*assemblybegin)(Vec);            /* start global assembly */
 45:   PetscErrorCode (*assemblyend)(Vec);              /* end global assembly */
 46:   PetscErrorCode (*getarray)(Vec, PetscScalar **); /* get data array */
 47:   PetscErrorCode (*getsize)(Vec, PetscInt *);
 48:   PetscErrorCode (*getlocalsize)(Vec, PetscInt *);
 49:   PetscErrorCode (*restorearray)(Vec, PetscScalar **); /* restore data array */
 50:   PetscErrorCode (*max)(Vec, PetscInt *, PetscReal *); /* z = max(x); idx=index of max(x) */
 51:   PetscErrorCode (*min)(Vec, PetscInt *, PetscReal *); /* z = min(x); idx=index of min(x) */
 52:   PetscErrorCode (*setrandom)(Vec, PetscRandom);       /* set y[j] = random numbers */
 53:   PetscErrorCode (*setoption)(Vec, VecOption, PetscBool);
 54:   PetscErrorCode (*setvaluesblocked)(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
 55:   PetscErrorCode (*destroy)(Vec);
 56:   PetscErrorCode (*view)(Vec, PetscViewer);
 57:   PetscErrorCode (*placearray)(Vec, const PetscScalar *);   /* place data array */
 58:   PetscErrorCode (*replacearray)(Vec, const PetscScalar *); /* replace data array */
 59:   PetscErrorCode (*dot_local)(Vec, Vec, PetscScalar *);
 60:   PetscErrorCode (*tdot_local)(Vec, Vec, PetscScalar *);
 61:   PetscErrorCode (*norm_local)(Vec, NormType, PetscReal *);
 62:   PetscErrorCode (*mdot_local)(Vec, PetscInt, const Vec[], PetscScalar *);
 63:   PetscErrorCode (*mtdot_local)(Vec, PetscInt, const Vec[], PetscScalar *);
 64:   PetscErrorCode (*load)(Vec, PetscViewer);
 65:   PetscErrorCode (*reciprocal)(Vec);
 66:   PetscErrorCode (*conjugate)(Vec);
 67:   PetscErrorCode (*setlocaltoglobalmapping)(Vec, ISLocalToGlobalMapping);
 68:   PetscErrorCode (*setvalueslocal)(Vec, PetscInt, const PetscInt *, const PetscScalar *, InsertMode);
 69:   PetscErrorCode (*resetarray)(Vec); /* vector points to its original array, i.e. undoes any VecPlaceArray() */
 70:   PetscErrorCode (*setfromoptions)(Vec, PetscOptionItems *);
 71:   PetscErrorCode (*maxpointwisedivide)(Vec, Vec, PetscReal *); /* m = max abs(x ./ y) */
 72:   PetscErrorCode (*pointwisemax)(Vec, Vec, Vec);
 73:   PetscErrorCode (*pointwisemaxabs)(Vec, Vec, Vec);
 74:   PetscErrorCode (*pointwisemin)(Vec, Vec, Vec);
 75:   PetscErrorCode (*getvalues)(Vec, PetscInt, const PetscInt[], PetscScalar[]);
 76:   PetscErrorCode (*sqrt)(Vec);
 77:   PetscErrorCode (*abs)(Vec);
 78:   PetscErrorCode (*exp)(Vec);
 79:   PetscErrorCode (*log)(Vec);
 80:   PetscErrorCode (*shift)(Vec, PetscScalar);
 81:   PetscErrorCode (*create)(Vec);
 82:   PetscErrorCode (*stridegather)(Vec, PetscInt, Vec, InsertMode);
 83:   PetscErrorCode (*stridescatter)(Vec, PetscInt, Vec, InsertMode);
 84:   PetscErrorCode (*dotnorm2)(Vec, Vec, PetscScalar *, PetscScalar *);
 85:   PetscErrorCode (*getsubvector)(Vec, IS, Vec *);
 86:   PetscErrorCode (*restoresubvector)(Vec, IS, Vec *);
 87:   PetscErrorCode (*getarrayread)(Vec, const PetscScalar **);
 88:   PetscErrorCode (*restorearrayread)(Vec, const PetscScalar **);
 89:   PetscErrorCode (*stridesubsetgather)(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
 90:   PetscErrorCode (*stridesubsetscatter)(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
 91:   PetscErrorCode (*viewnative)(Vec, PetscViewer);
 92:   PetscErrorCode (*loadnative)(Vec, PetscViewer);
 93:   PetscErrorCode (*createlocalvector)(Vec, Vec *);
 94:   PetscErrorCode (*getlocalvector)(Vec, Vec);
 95:   PetscErrorCode (*restorelocalvector)(Vec, Vec);
 96:   PetscErrorCode (*getlocalvectorread)(Vec, Vec);
 97:   PetscErrorCode (*restorelocalvectorread)(Vec, Vec);
 98:   PetscErrorCode (*bindtocpu)(Vec, PetscBool);
 99:   PetscErrorCode (*getarraywrite)(Vec, PetscScalar **);
100:   PetscErrorCode (*restorearraywrite)(Vec, PetscScalar **);
101:   PetscErrorCode (*getarrayandmemtype)(Vec, PetscScalar **, PetscMemType *);
102:   PetscErrorCode (*restorearrayandmemtype)(Vec, PetscScalar **);
103:   PetscErrorCode (*getarrayreadandmemtype)(Vec, const PetscScalar **, PetscMemType *);
104:   PetscErrorCode (*restorearrayreadandmemtype)(Vec, const PetscScalar **);
105:   PetscErrorCode (*getarraywriteandmemtype)(Vec, PetscScalar **, PetscMemType *);
106:   PetscErrorCode (*restorearraywriteandmemtype)(Vec, PetscScalar **, PetscMemType *);
107:   PetscErrorCode (*concatenate)(PetscInt, const Vec[], Vec *, IS *[]);
108:   PetscErrorCode (*sum)(Vec, PetscScalar *);
109:   PetscErrorCode (*setpreallocationcoo)(Vec, PetscCount, const PetscInt[]);
110:   PetscErrorCode (*setvaluescoo)(Vec, const PetscScalar[], InsertMode);
111: };

113: /*
114:     The stash is used to temporarily store inserted vec values that
115:   belong to another processor. During the assembly phase the stashed
116:   values are moved to the correct processor and
117: */

119: typedef struct {
120:   PetscInt     nmax;     /* maximum stash size */
121:   PetscInt     umax;     /* max stash size user wants */
122:   PetscInt     oldnmax;  /* the nmax value used previously */
123:   PetscInt     n;        /* stash size */
124:   PetscInt     bs;       /* block size of the stash */
125:   PetscInt     reallocs; /* preserve the no of mallocs invoked */
126:   PetscInt    *idx;      /* global row numbers in stash */
127:   PetscScalar *array;    /* array to hold stashed values */
128:   /* The following variables are used for communication */
129:   MPI_Comm     comm;
130:   PetscMPIInt  size, rank;
131:   PetscMPIInt  tag1, tag2;
132:   MPI_Request *send_waits;        /* array of send requests */
133:   MPI_Request *recv_waits;        /* array of receive requests */
134:   MPI_Status  *send_status;       /* array of send status */
135:   PetscInt     nsends, nrecvs;    /* numbers of sends and receives */
136:   PetscScalar *svalues, *rvalues; /* sending and receiving data */
137:   PetscInt    *sindices, *rindices;
138:   PetscInt     rmax;       /* maximum message length */
139:   PetscInt    *nprocs;     /* tmp data used both during scatterbegin and end */
140:   PetscInt     nprocessed; /* number of messages already processed */
141:   PetscBool    donotstash;
142:   PetscBool    ignorenegidx; /* ignore negative indices passed into VecSetValues/VetGetValues */
143:   InsertMode   insertmode;
144:   PetscInt    *bowners;
145: } VecStash;

147: struct _p_Vec {
148:   PETSCHEADER(struct _VecOps);
149:   PetscLayout map;
150:   void       *data; /* implementation-specific data */
151:   PetscBool   array_gotten;
152:   VecStash    stash, bstash; /* used for storing off-proc values during assembly */
153:   PetscBool   petscnative;   /* means the ->data starts with VECHEADER and can use VecGetArrayFast()*/
154: #if PetscDefined(USE_DEBUG)
155:   PetscStack lockstack; /* the file,func,line of where locks are added */
156:   PetscInt   lock;      /* lock state. vector can be free (=0), locked for read (>0) or locked for write(<0) */
157: #endif
158:   PetscOffloadMask offloadmask; /* a mask which indicates where the valid vector data is (GPU, CPU or both) */
159: #if defined(PETSC_HAVE_DEVICE)
160:   void     *spptr; /* this is the special pointer to the array on the GPU */
161:   PetscBool boundtocpu;
162:   PetscBool bindingpropagates;
163:   size_t    minimum_bytes_pinned_memory; /* minimum data size in bytes for which pinned memory will be allocated */
164:   PetscBool pinned_memory;               /* PETSC_TRUE if the current host allocation has been made from pinned memory. */
165: #endif
166:   char *defaultrandtype;
167: };

169: PETSC_EXTERN PetscLogEvent VEC_SetRandom;
170: PETSC_EXTERN PetscLogEvent VEC_View;
171: PETSC_EXTERN PetscLogEvent VEC_Max;
172: PETSC_EXTERN PetscLogEvent VEC_Min;
173: PETSC_EXTERN PetscLogEvent VEC_Dot;
174: PETSC_EXTERN PetscLogEvent VEC_MDot;
175: PETSC_EXTERN PetscLogEvent VEC_TDot;
176: PETSC_EXTERN PetscLogEvent VEC_MTDot;
177: PETSC_EXTERN PetscLogEvent VEC_Norm;
178: PETSC_EXTERN PetscLogEvent VEC_Normalize;
179: PETSC_EXTERN PetscLogEvent VEC_Scale;
180: PETSC_EXTERN PetscLogEvent VEC_Copy;
181: PETSC_EXTERN PetscLogEvent VEC_Set;
182: PETSC_EXTERN PetscLogEvent VEC_AXPY;
183: PETSC_EXTERN PetscLogEvent VEC_AYPX;
184: PETSC_EXTERN PetscLogEvent VEC_WAXPY;
185: PETSC_EXTERN PetscLogEvent VEC_MAXPY;
186: PETSC_EXTERN PetscLogEvent VEC_AssemblyEnd;
187: PETSC_EXTERN PetscLogEvent VEC_PointwiseMult;
188: PETSC_EXTERN PetscLogEvent VEC_SetValues;
189: PETSC_EXTERN PetscLogEvent VEC_SetPreallocateCOO;
190: PETSC_EXTERN PetscLogEvent VEC_SetValuesCOO;
191: PETSC_EXTERN PetscLogEvent VEC_Load;
192: PETSC_EXTERN PetscLogEvent VEC_ScatterBegin;
193: PETSC_EXTERN PetscLogEvent VEC_ScatterEnd;
194: PETSC_EXTERN PetscLogEvent VEC_ReduceArithmetic;
195: PETSC_EXTERN PetscLogEvent VEC_ReduceCommunication;
196: PETSC_EXTERN PetscLogEvent VEC_ReduceBegin;
197: PETSC_EXTERN PetscLogEvent VEC_ReduceEnd;
198: PETSC_EXTERN PetscLogEvent VEC_Swap;
199: PETSC_EXTERN PetscLogEvent VEC_AssemblyBegin;
200: PETSC_EXTERN PetscLogEvent VEC_DotNorm2;
201: PETSC_EXTERN PetscLogEvent VEC_AXPBYPCZ;
202: PETSC_EXTERN PetscLogEvent VEC_Ops;
203: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyToGPU;
204: PETSC_EXTERN PetscLogEvent VEC_ViennaCLCopyFromGPU;
205: PETSC_EXTERN PetscLogEvent VEC_CUDACopyToGPU;
206: PETSC_EXTERN PetscLogEvent VEC_CUDACopyFromGPU;
207: PETSC_EXTERN PetscLogEvent VEC_CUDACopyToGPUSome;
208: PETSC_EXTERN PetscLogEvent VEC_CUDACopyFromGPUSome;
209: PETSC_EXTERN PetscLogEvent VEC_HIPCopyToGPU;
210: PETSC_EXTERN PetscLogEvent VEC_HIPCopyFromGPU;
211: PETSC_EXTERN PetscLogEvent VEC_HIPCopyToGPUSome;
212: PETSC_EXTERN PetscLogEvent VEC_HIPCopyFromGPUSome;

214: PETSC_EXTERN PetscErrorCode VecView_Seq(Vec, PetscViewer);
215: #if defined(PETSC_HAVE_VIENNACL)
216: PETSC_EXTERN PetscErrorCode VecViennaCLAllocateCheckHost(Vec v);
217: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPU(Vec v);
218: #endif
219: #if defined(PETSC_HAVE_CUDA)
220: PETSC_EXTERN PetscErrorCode VecCUDAAllocateCheckHost(Vec v);
221: PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPU(Vec v);
222: #endif
223: #if defined(PETSC_HAVE_HIP)
224: PETSC_EXTERN PetscErrorCode VecHIPAllocateCheckHost(Vec v);
225: PETSC_EXTERN PetscErrorCode VecHIPCopyFromGPU(Vec v);
226: #endif

228: /*
229:      Common header shared by array based vectors,
230:    currently Vec_Seq and Vec_MPI
231: */
232: #define VECHEADER \
233:   PetscScalar *array; \
234:   PetscScalar *array_allocated; /* if the array was allocated by PETSc this is its pointer */ \
235:   PetscScalar *unplacedarray;   /* if one called VecPlaceArray(), this is where it stashed the original */

237: /* Get Root type of vector. e.g. VECSEQ -> VECSTANDARD, VECMPICUDA -> VECCUDA */
238: PETSC_EXTERN PetscErrorCode VecGetRootType_Private(Vec, VecType *);

240: /* Default obtain and release vectors; can be used by any implementation */
241: PETSC_EXTERN PetscErrorCode VecDuplicateVecs_Default(Vec, PetscInt, Vec *[]);
242: PETSC_EXTERN PetscErrorCode VecDestroyVecs_Default(PetscInt, Vec[]);
243: PETSC_EXTERN PetscErrorCode VecView_Binary(Vec, PetscViewer);
244: PETSC_EXTERN PetscErrorCode VecLoad_Binary(Vec, PetscViewer);
245: PETSC_EXTERN PetscErrorCode VecLoad_Default(Vec, PetscViewer);

247: PETSC_EXTERN PetscInt NormIds[7]; /* map from NormType to IDs used to cache/retreive values of norms */

249: PETSC_INTERN PetscErrorCode VecStashCreate_Private(MPI_Comm, PetscInt, VecStash *);
250: PETSC_INTERN PetscErrorCode VecStashDestroy_Private(VecStash *);
251: PETSC_EXTERN PetscErrorCode VecStashExpand_Private(VecStash *, PetscInt);
252: PETSC_INTERN PetscErrorCode VecStashScatterEnd_Private(VecStash *);
253: PETSC_INTERN PetscErrorCode VecStashSetInitialSize_Private(VecStash *, PetscInt);
254: PETSC_INTERN PetscErrorCode VecStashGetInfo_Private(VecStash *, PetscInt *, PetscInt *);
255: PETSC_INTERN PetscErrorCode VecStashScatterBegin_Private(VecStash *, PetscInt *);
256: PETSC_INTERN PetscErrorCode VecStashScatterGetMesg_Private(VecStash *, PetscMPIInt *, PetscInt **, PetscScalar **, PetscInt *);
257: PETSC_INTERN PetscErrorCode VecStashSortCompress_Private(VecStash *);
258: PETSC_INTERN PetscErrorCode VecStashGetOwnerList_Private(VecStash *, PetscLayout, PetscMPIInt *, PetscMPIInt **);

260: /*
261:   VecStashValue_Private - inserts a single value into the stash.

263:   Input Parameters:
264:   stash  - the stash
265:   idx    - the global of the inserted value
266:   values - the value inserted
267: */
268: static inline PetscErrorCode VecStashValue_Private(VecStash *stash, PetscInt row, PetscScalar value)
269: {
270:   /* Check and see if we have sufficient memory */
271:   if (((stash)->n + 1) > (stash)->nmax) VecStashExpand_Private(stash, 1);
272:   (stash)->idx[(stash)->n]   = row;
273:   (stash)->array[(stash)->n] = value;
274:   (stash)->n++;
275:   return 0;
276: }

278: /*
279:   VecStashValuesBlocked_Private - inserts 1 block of values into the stash.

281:   Input Parameters:
282:   stash  - the stash
283:   idx    - the global block index
284:   values - the values inserted
285: */
286: static inline PetscErrorCode VecStashValuesBlocked_Private(VecStash *stash, PetscInt row, PetscScalar *values)
287: {
288:   PetscInt     stash_bs = (stash)->bs;
289:   PetscScalar *array;

291:   if (((stash)->n + 1) > (stash)->nmax) VecStashExpand_Private(stash, 1);
292:   array                    = (stash)->array + stash_bs * (stash)->n;
293:   (stash)->idx[(stash)->n] = row;
294:   PetscArraycpy(array, values, stash_bs);
295:   (stash)->n++;
296:   return 0;
297: }

299: PETSC_INTERN PetscErrorCode VecStrideGather_Default(Vec, PetscInt, Vec, InsertMode);
300: PETSC_INTERN PetscErrorCode VecStrideScatter_Default(Vec, PetscInt, Vec, InsertMode);
301: PETSC_INTERN PetscErrorCode VecReciprocal_Default(Vec);
302: PETSC_INTERN PetscErrorCode VecStrideSubSetGather_Default(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
303: PETSC_INTERN PetscErrorCode VecStrideSubSetScatter_Default(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);

305: #if defined(PETSC_HAVE_MATLAB)
306: PETSC_EXTERN PetscErrorCode VecMatlabEnginePut_Default(PetscObject, void *);
307: PETSC_EXTERN PetscErrorCode VecMatlabEngineGet_Default(PetscObject, void *);
308: #endif

310: PETSC_EXTERN PetscErrorCode PetscSectionGetField_Internal(PetscSection, PetscSection, Vec, PetscInt, PetscInt, PetscInt, IS *, Vec *);
311: PETSC_EXTERN PetscErrorCode PetscSectionRestoreField_Internal(PetscSection, PetscSection, Vec, PetscInt, PetscInt, PetscInt, IS *, Vec *);

313: #define VecCheckSameLocalSize(x, ar1, y, ar2) \
314:   do { \
316:   } while (0)

318: #define VecCheckSameSize(x, ar1, y, ar2) \
319:   do { \
321:                (y)->map->N); \
322:     VecCheckSameLocalSize(x, ar1, y, ar2); \
323:   } while (0)

325: #define VecCheckLocalSize(x, ar1, n) \
326:   do { \
328:   } while (0)

330: #define VecCheckSize(x, ar1, n, N) \
331:   do { \
333:     VecCheckLocalSize(x, ar1, n); \
334:   } while (0)

336: typedef struct _VecTaggerOps *VecTaggerOps;
337: struct _VecTaggerOps {
338:   PetscErrorCode (*create)(VecTagger);
339:   PetscErrorCode (*destroy)(VecTagger);
340:   PetscErrorCode (*setfromoptions)(VecTagger, PetscOptionItems *);
341:   PetscErrorCode (*setup)(VecTagger);
342:   PetscErrorCode (*view)(VecTagger, PetscViewer);
343:   PetscErrorCode (*computeboxes)(VecTagger, Vec, PetscInt *, VecTaggerBox **, PetscBool *);
344:   PetscErrorCode (*computeis)(VecTagger, Vec, IS *, PetscBool *);
345: };
346: struct _p_VecTagger {
347:   PETSCHEADER(struct _VecTaggerOps);
348:   void     *data;
349:   PetscInt  blocksize;
350:   PetscBool invert;
351:   PetscBool setupcalled;
352: };

354: PETSC_EXTERN PetscBool      VecTaggerRegisterAllCalled;
355: PETSC_EXTERN PetscErrorCode VecTaggerRegisterAll(void);
356: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS_FromBoxes(VecTagger, Vec, IS *, PetscBool *);
357: PETSC_EXTERN PetscMPIInt    Petsc_Reduction_keyval;

359: PETSC_INTERN PetscInt       VecGetSubVectorSavedStateId;
360: PETSC_INTERN PetscErrorCode VecGetSubVectorContiguityAndBS_Private(Vec, IS, PetscBool *, PetscInt *, PetscInt *);
361: PETSC_INTERN PetscErrorCode VecGetSubVectorThroughVecScatter_Private(Vec, IS, PetscInt, Vec *);

363: #if defined(PETSC_HAVE_KOKKOS)
364: PETSC_INTERN PetscErrorCode VecCreateSeqKokkosWithArrays_Private(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
365: PETSC_INTERN PetscErrorCode VecCreateMPIKokkosWithArrays_Private(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, const PetscScalar *, Vec *);
366: #endif

368: /* std::upper_bound(): Given a sorted array, return index of the first element in range [first,last) whose value
369:    is greater than value, or last if there is no such element.
370: */
371: static inline PetscErrorCode PetscSortedIntUpperBound(PetscInt *array, PetscCount first, PetscCount last, PetscInt value, PetscCount *upper)
372: {
373:   PetscCount it, step, count = last - first;

375:   while (count > 0) {
376:     it   = first;
377:     step = count / 2;
378:     it += step;
379:     if (!(value < array[it])) {
380:       first = ++it;
381:       count -= step + 1;
382:     } else count = step;
383:   }
384:   *upper = first;
385:   return 0;
386: }

388: #endif /* __VECIMPL_H */