.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PMIX_COORD_CREATE" "3" "Sep 27, 2026" "" "OpenPMIx"
.sp
\fBPMIx_Coord_create\fP — Allocate and initialize an array of
pmix_coord_t(5) \%<#\:man5-pmix-coord-t> structures.
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <pmix.h>

pmix_coord_t* PMIx_Coord_create(size_t dims,
                                size_t number);
.EE
.UNINDENT
.UNINDENT
.SS Python Syntax
.sp
No Python equivalent
.SH INPUT PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBdims\fP: Number of dimensions to allocate for the coordinate array of the
created structure(s).
.IP \(bu 2
\fBnumber\fP: Number of pmix_coord_t(5) \%<#\:man5-pmix-coord-t> structures
to allocate.
.UNINDENT
.SH DESCRIPTION
.sp
Allocate a contiguous array of \fBnumber\fP pmix_coord_t \%<#\:man5-pmix-coord-t> structures on the heap. The \fBview\fP field is set to
\fBPMIX_COORD_VIEW_UNDEF\fP and the \fBdims\fP field to \fBdims\fP\&. When \fBdims\fP is
non\-zero, a \fBdims\fP\-element array of \fBuint32_t\fP coordinate values is
allocated and zero\-initialized and attached via the \fBcoord\fP pointer; when
\fBdims\fP is zero, \fBcoord\fP is left \fBNULL\fP\&.
.sp
If \fBnumber\fP is zero, no allocation is performed and \fBNULL\fP is returned.
.SH RETURN VALUE
.sp
Returns a pointer to the newly allocated array, or \fBNULL\fP if \fBnumber\fP is
zero or the allocation fails.
.SH NOTES
.sp
An array obtained from \fBPMIx_Coord_create\fP must be released with
PMIx_Coord_free(3) \%<#\:man3-pmix-coord-free>, which destructs each
element’s coordinate array and frees the array storage itself. Pass the same
\fBnumber\fP used at creation.
.sp
The convenience macro \fBPMIX_COORD_CREATE\fP is provided as a wrapper around
this function.
.SH EXAMPLES
.sp
Create a single three\-dimensional coordinate and release it:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
pmix_coord_t *coord;

coord = PMIx_Coord_create(3, 1);
coord\->view = PMIX_COORD_LOGICAL_VIEW;
coord\->coord[0] = 0;
coord\->coord[1] = 1;
coord\->coord[2] = 2;
/* ... use the coordinate ... */
PMIx_Coord_free(coord, 1);
.EE
.UNINDENT
.UNINDENT
.sp
\fBSee also:\fP
.INDENT 0.0
.INDENT 3.5
PMIx_Coord_free(3) \%<#\:man3-pmix-coord-free>,
PMIx_Coord_construct(3) \%<#\:man3-pmix-coord-construct>,
PMIx_Coord_destruct(3) \%<#\:man3-pmix-coord-destruct>,
pmix_coord_t(5) \%<#\:man5-pmix-coord-t>
.UNINDENT
.UNINDENT
.SH Copyright
2014-2026, OpenPMIx Community
.\" End of generated man page.