File: shmem_pe_accessible.3in

package info (click to toggle)
openmpi 3.1.3-11
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 118,572 kB
  • sloc: ansic: 628,972; f90: 17,993; makefile: 13,761; sh: 7,051; java: 6,360; perl: 3,215; cpp: 2,225; python: 1,350; lex: 988; fortran: 52; tcl: 12
file content (54 lines) | stat: -rw-r--r-- 1,115 bytes parent folder | download | duplicates (4)
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
.\" -*- nroff -*-
.\" Copyright (c) 2015      University of Houston.  All rights reserved.
.\" Copyright (c) 2015      Mellanox Technologies, Inc.
.\" $COPYRIGHT$
.de Vb
.ft CW
.nf
..
.de Ve
.ft R

.fi
..
.TH "SHMEM\\_PE\\_ACCESSIBLE" "3" "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME

shmem_pe_accessible \- Determines whether a processing element (PE) is accessible via
SHMEM data transfer operations.
.SH SYNOPSIS

C:
.Vb
#include <mpp/shmem.h>

int shmem_pe_accessible(int pe);
.Ve
Fortran:
.Vb
INCLUDE "mpp/shmem.fh"

LOGICAL LOG, SHMEM_PE_ACCESSIBLE
INTEGER pe

LOG = SHMEM_PE_ACCESSIBLE(pe)
.Ve
.SH DESCRIPTION

shmem_pe_accessible returns a value that indicates whether the calling PE is able to perform
OpenSHMEM communication operations with the remote PE.
.SH RETURN VALUES

.TP
C/C++
The return value is 1 if the specified PE is a valid remote PE for SHMEM functions;
otherwise,it is 0.
.TP
Fortran
The return value is \&.TRUE. if the specified PE is a valid remote PE for SHMEM
functions; otherwise, it is \&.FALSE..
.PP
.SH SEE ALSO

\fIintro_shmem\fP(3),
\fIshmem_addr_accessible\fP(3)