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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 2002-2-1 (1.70)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Function: ensure</TITLE>
<META NAME="description" CONTENT="Function: ensure">
<META NAME="keywords" CONTENT="users_guide">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="users_guide.css">
<LINK REL="next" HREF="node97.html">
<LINK REL="previous" HREF="node95.html">
<LINK REL="up" HREF="node65.html">
<LINK REL="next" HREF="node97.html">
</HEAD>
<BODY >
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html2088"
HREF="node97.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html2082"
HREF="node65.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html2076"
HREF="node95.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html2084"
HREF="node14.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html2086"
HREF="node317.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html2089"
HREF="node97.html">Function: first</A>
<B> Up:</B> <A NAME="tex2html2083"
HREF="node65.html">The Array API</A>
<B> Previous:</B> <A NAME="tex2html2077"
HREF="node95.html">Function: copy</A>
<B> <A NAME="tex2html2085"
HREF="node14.html">Contents</A></B>
<B> <A NAME="tex2html2087"
HREF="node317.html">Index</A></B>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H3><A NAME="SECTION024463100000000000000"></A><A NAME="3022"></A>
<BR>
Function: ensure
</H3>
<P>
<BR>
<PRE CLASS="verbatim">/* C */
struct sidl_double__array *
sidl_double__array_ensure(const struct sidl_double__array *src,
int32_t dimen,
int ordering);
// C++
void
sidl::array<double>::ensure(int32_t dimen, int ordering);
C FORTRAN 77
subroutine sidl_double__array_ensure_f(src, dimen, ordering, result)
integer*8 src, result
integer*4 dimen, ordering
! FORTRAN 90
subroutine ensure(src, dimen, ordering, result)
type(sidl_double_1d), intent(in) :: src ! type depends on array dimension
type(sidl_double_1d), intent(out) :: result! type depends on array dimension
integer (selected_int_kind(9)) :: dimen, ordering
</PRE></td></tr></table></blockquote>
<P>
This method is used to obtain a matrix with a guaranteed ordering and
dimension from an array with uncertain properties. If the incoming
array has the required ordering and dimension, its reference count is
incremented, and it is returned. If it doesn't, a copy with the
correct ordering is created and returned. In either case, the caller
knows that the returned matrix (if not NULL) has the desired
properties.
<P>
This method is used internally to enforce the array ordering
constraints in SIDL. Clients can use it in similar ways. However,
because the method was intended as an internal Babel feature,
is not available in Java or Python.
<P>
The ordering parameter should be one of the constants defined in
<TT>enum sidl_array_ordering</TT> (e.g.
<BR><TT>sidl_general_order</TT>,
<TT>sidl_column_major_order</TT>, or <TT>sidl_row_major_order</TT>). If
you pass in
<BR><TT>sidl_general_order</TT>, this routine will only check
the dimension of the matrix.
<P>
<BR><HR>
<ADDRESS>
<br><br>babel-0.10.2<br>users_guide Last Modified 2005-03-23<br><br><a href="http://www.llnl.gov/CASC/components">http://www.llnl.gov/CASC/components</a><br><a href="mailto:components@llnl.gov">components@llnl.gov</a>
</ADDRESS>
</BODY>
</HTML>
|
