ISGeneralSetIndicesFromMask — PETSc 3.21.4 documentation

Skip to main content
`Ctrl`+`K`

# ISGeneralSetIndicesFromMask

Sets the indices for an `ISGENERAL` index set using a boolean mask

## Synopsis

    #include "petscis.h"
    PetscErrorCode ISGeneralSetIndicesFromMask(IS is, PetscInt rstart, PetscInt rend, const PetscBool mask[])

Collective

## Input Parameters

- is - the index set

- rstart - the range start index (inclusive)

- rend - the range end index (exclusive)

- mask - the boolean mask array of length rend-rstart, indices will be set for each `PETSC_TRUE` value in the array

## Note

The mask array may be freed by the user after this call.

## Example

       PetscBool mask[] = {PETSC_FALSE, PETSC_TRUE, PETSC_FALSE, PETSC_FALSE, PETSC_TRUE};
       ISGeneralSetIndicesFromMask(is,10,15,mask);

will feed the `IS` with indices

      {11, 14}

locally.

## See Also

Low-level Vector Communication, `IS`, `ISCreateGeneral()`, `ISGeneralSetIndices()`, `ISGENERAL`

## Level

beginner

## Location

src/vec/is/is/impls/general/general.c

## Implementations

ISGeneralSetIndicesFromMask_General() in src/vec/is/is/impls/general/general.c

Index of all IS routines
Table of Contents for all manual pages
Index of all manual pages