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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<HEAD>
<TITLE>AARM95 - Input-Output for Real Types</TITLE>
<META NAME="Author" CONTENT="JTC1/SC22/WG9/ARG, by Randall Brukardt, ARG Editor">
<META NAME="GENERATOR" CONTENT="Arm_Form.Exe, Ada Reference Manual generator">
<STYLE type="text/css">
DIV.paranum {position: absolute; font-family: Arial, Helvetica, sans-serif; left: 0.5 em; top: auto}
TT {font-family: "Courier New", monospace}
DT {display: compact}
DIV.Normal {font-family: "Times New Roman", Times, serif; margin-bottom: 0.6em}
DIV.Wide {font-family: "Times New Roman", Times, serif; margin-top: 0.6em; margin-bottom: 0.6em}
DIV.Annotations {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-bottom: 0.6em}
DIV.WideAnnotations {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-top: 0.6em; margin-bottom: 0.6em}
DIV.Index {font-family: "Times New Roman", Times, serif}
DIV.SyntaxSummary {font-family: "Times New Roman", Times, serif; margin-left: 2.0em; margin-bottom: 0.4em}
DIV.Notes {font-family: "Times New Roman", Times, serif; margin-left: 2.0em; margin-bottom: 0.6em}
DIV.NotesHeader {font-family: "Times New Roman", Times, serif; margin-left: 2.0em}
DIV.SyntaxIndented {font-family: "Times New Roman", Times, serif; margin-left: 2.0em; margin-bottom: 0.4em}
DIV.Indented {font-family: "Times New Roman", Times, serif; margin-left: 6.0em; margin-bottom: 0.6em}
DIV.CodeIndented {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-bottom: 0.6em}
DIV.SmallIndented {font-family: "Times New Roman", Times, serif; margin-left: 10.0em; margin-bottom: 0.6em}
DIV.SmallCodeIndented {font-family: "Times New Roman", Times, serif; margin-left: 8.0em; margin-bottom: 0.6em}
DIV.Examples {font-family: "Courier New", monospace; margin-left: 2.0em; margin-bottom: 0.6em}
DIV.SmallExamples {font-family: "Courier New", monospace; font-size: 80%; margin-left: 7.5em; margin-bottom: 0.6em}
DIV.IndentedExamples {font-family: "Courier New", monospace; margin-left: 8.0em; margin-bottom: 0.6em}
DIV.SmallIndentedExamples {font-family: "Courier New", monospace; font-size: 80%; margin-left: 15.0em; margin-bottom: 0.6em}
UL.Bulleted {font-family: "Times New Roman", Times, serif; margin-left: 2.0em; margin-right: 2.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.SmallBulleted {font-family: "Times New Roman", Times, serif; margin-left: 6.0em; margin-right: 6.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.NestedBulleted {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-right: 4.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.SmallNestedBulleted {font-family: "Times New Roman", Times, serif; margin-left: 8.0em; margin-right: 8.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.IndentedBulleted {font-family: "Times New Roman", Times, serif; margin-left: 8.0em; margin-right: 8.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.CodeIndentedBulleted {font-family: "Times New Roman", Times, serif; margin-left: 6.0em; margin-right: 6.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.CodeIndentedNestedBulleted {font-family: "Times New Roman", Times, serif; margin-left: 8.0em; margin-right: 8.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.SyntaxIndentedBulleted {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-right: 4.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.NotesBulleted {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-right: 4.0em; margin-top: 0em; margin-bottom: 0.5em}
UL.NotesNestedBulleted {font-family: "Times New Roman", Times, serif; margin-left: 6.0em; margin-right: 6.0em; margin-top: 0em; margin-bottom: 0.5em}
DL.Hanging {font-family: "Times New Roman", Times, serif; margin-top: 0em; margin-bottom: 0.6em}
DD.Hanging {margin-left: 6.0em}
DL.IndentedHanging {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-top: 0em; margin-bottom: 0.6em}
DD.IndentedHanging {margin-left: 2.0em}
DL.HangingInBulleted {font-family: "Times New Roman", Times, serif; margin-left: 2.0em; margin-right: 2.0em; margin-top: 0em; margin-bottom: 0.5em}
DD.HangingInBulleted {margin-left: 4.0em}
DL.SmallHanging {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-top: 0em; margin-bottom: 0.6em}
DD.SmallHanging {margin-left: 7.5em}
DL.SmallIndentedHanging {font-family: "Times New Roman", Times, serif; margin-left: 8.0em; margin-top: 0em; margin-bottom: 0.6em}
DD.SmallIndentedHanging {margin-left: 2.0em}
DL.SmallHangingInBulleted {font-family: "Times New Roman", Times, serif; margin-left: 6.0em; margin-right: 6.0em; margin-top: 0em; margin-bottom: 0.5em}
DD.SmallHangingInBulleted {margin-left: 5.0em}
DL.Enumerated {font-family: "Times New Roman", Times, serif; margin-right: 0.0em; margin-top: 0em; margin-bottom: 0.5em}
DD.Enumerated {margin-left: 2.0em}
DL.SmallEnumerated {font-family: "Times New Roman", Times, serif; margin-left: 4.0em; margin-right: 4.0em; margin-top: 0em; margin-bottom: 0.5em}
DD.SmallEnumerated {margin-left: 2.5em}
DL.NestedEnumerated {font-family: "Times New Roman", Times, serif; margin-left: 2.0em; margin-right: 2.0em; margin-top: 0em; margin-bottom: 0.5em}
DL.SmallNestedEnumerated {font-family: "Times New Roman", Times, serif; margin-left: 6.0em; margin-right: 6.0em; margin-top: 0em; margin-bottom: 0.5em}
</STYLE>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFF0" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
<P><A HREF="AA-TOC.html">Contents</A> <A HREF="AA-0-29.html">Index</A> <A HREF="AA-A-10-8.html">Previous</A> <A HREF="AA-A-10-10.html">Next</A></P>
<HR>
<H1> A.10.9 Input-Output for Real Types</H1>
<H4 ALIGN=CENTER>Static Semantics</H4>
<DIV Class="Paranum"><FONT SIZE=-2>1</FONT></DIV>
<DIV Class="Normal"> The following procedures are defined in the generic
packages Float_IO, Fixed_IO, and Decimal_IO, which have to be instantiated
for the appropriate floating point, ordinary fixed point, or decimal
fixed point type respectively (indicated by Num in the specifications).</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>2</FONT></DIV>
<DIV Class="Normal" Style="margin-bottom: 0.4em"> Values are output
as decimal literals without low line characters. The format of each value
output consists of a Fore field, a decimal point, an Aft field, and (if
a nonzero Exp parameter is supplied) the letter E and an Exp field. The
two possible formats thus correspond to:</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>3</FONT></DIV>
<DIV Class="Examples"><TT>Fore . Aft</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>4</FONT></DIV>
<DIV Class="Normal" Style="margin-bottom: 0.4em"> and to:</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>5</FONT></DIV>
<DIV Class="Examples"><TT>Fore . Aft E Exp</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>6</FONT></DIV>
<DIV Class="Normal"> without any spaces between these fields. The Fore
field may include leading spaces, and a minus sign for negative values.
The Aft field includes only decimal digits (possibly with trailing zeros).
The Exp field includes the sign (plus or minus) and the exponent (possibly
with leading zeros).</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>7</FONT></DIV>
<DIV Class="Normal" Style="margin-bottom: 0.4em"> For floating point
types, the default lengths of these fields are defined by the following
variables that are declared in the generic package Float_IO:</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>8</FONT></DIV>
<DIV Class="Examples" Style="margin-bottom: 0.9em"><TT>Default_Fore : Field := 2;<BR>
Default_Aft : Field := Num'Digits-1;<BR>
Default_Exp : Field := 3;</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>9</FONT></DIV>
<DIV Class="Normal" Style="margin-bottom: 0.4em"> For ordinary or
decimal fixed point types, the default lengths of these fields are defined
by the following variables that are declared in the generic packages
Fixed_IO and Decimal_IO, respectively:</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>10</FONT></DIV>
<DIV Class="Examples" Style="margin-bottom: 0.9em"><TT>Default_Fore : Field := Num'Fore;<BR>
Default_Aft : Field := Num'Aft;<BR>
Default_Exp : Field := 0;</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>11</FONT></DIV>
<DIV Class="Normal" Style="margin-bottom: 0.4em"> The following procedures
are provided: </DIV>
<DIV Class="Paranum"><FONT SIZE=-2>12</FONT></DIV>
<DIV Class="Examples"><TT><B>procedure</B> Get(File : <B>in</B> File_Type; Item : <B>out</B> Num; Width : <B>in</B> Field := 0);<BR>
<B>procedure</B> Get(Item : <B>out</B> Num; Width : <B>in</B> Field := 0);</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>13</FONT></DIV>
<DIV Class="CodeIndented" Style="margin-bottom: 0.4em">If the value
of the parameter Width is zero, skips any leading blanks, line terminators,
or page terminators, then reads the longest possible sequence of characters
matching the syntax of any of the following (see <A HREF="AA-2-4.html">2.4</A>):
</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>14</FONT></DIV>
<UL Class="CodeIndentedBulleted"><LI TYPE=DISC>[+|-]<FONT FACE="Arial, Helvetica">numeric_literal</FONT></LI></UL>
<DIV Class="Paranum"><FONT SIZE=-2>15</FONT></DIV>
<UL Class="CodeIndentedBulleted"><LI TYPE=DISC>[+|-]<FONT FACE="Arial, Helvetica">numeral</FONT>.[<FONT FACE="Arial, Helvetica">exponent</FONT>]</LI></UL>
<DIV Class="Paranum"><FONT SIZE=-2>16</FONT></DIV>
<UL Class="CodeIndentedBulleted"><LI TYPE=DISC>[+|-].<FONT FACE="Arial, Helvetica">numeral</FONT>[<FONT FACE="Arial, Helvetica">exponent</FONT>]</LI></UL>
<DIV Class="Paranum"><FONT SIZE=-2>17</FONT></DIV>
<UL Class="CodeIndentedBulleted"><LI TYPE=DISC>[+|-]<FONT FACE="Arial, Helvetica">base</FONT>#<FONT FACE="Arial, Helvetica">based_numeral</FONT>.#[<FONT FACE="Arial, Helvetica">exponent</FONT>]</LI></UL>
<DIV Class="Paranum"><FONT SIZE=-2>18</FONT></DIV>
<UL Class="CodeIndentedBulleted"><LI TYPE=DISC>[+|-]<FONT FACE="Arial, Helvetica">base</FONT>#.<FONT FACE="Arial, Helvetica">based_numeral</FONT>#[<FONT FACE="Arial, Helvetica">exponent</FONT>]
</LI></UL>
<DIV Class="Paranum"><FONT SIZE=-2>19</FONT></DIV>
<DIV Class="CodeIndented">If a nonzero value of Width is supplied, then
exactly Width characters are input, or the characters (possibly none)
up to a line terminator, whichever comes first; any skipped leading blanks
are included in the count.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>20</FONT></DIV>
<DIV Class="CodeIndented">Returns in the parameter Item the value of
type Num that corresponds to the sequence input, preserving the sign
(positive if none has been specified) of a zero value if Num is a floating
point type and Num'Signed_Zeros is True.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>21</FONT></DIV>
<DIV Class="CodeIndented" Style="margin-bottom: 0.9em">The exception
Data_Error is propagated if the sequence input does not have the required
syntax or if the value obtained is not of the subtype Num.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>22</FONT></DIV>
<DIV Class="Examples"><TT><B>procedure</B> Put(File : <B>in</B> File_Type;<BR>
Item : <B>in</B> Num;<BR>
Fore : <B>in</B> Field := Default_Fore;<BR>
Aft : <B>in</B> Field := Default_Aft;<BR>
Exp : <B>in</B> Field := Default_Exp);<BR>
<BR>
<B>procedure</B> Put(Item : <B>in</B> Num;<BR>
Fore : <B>in</B> Field := Default_Fore;<BR>
Aft : <B>in</B> Field := Default_Aft;<BR>
Exp : <B>in</B> Field := Default_Exp);</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>23</FONT></DIV>
<DIV Class="CodeIndented">Outputs the value of the parameter Item as
a decimal literal with the format defined by Fore, Aft and Exp. If the
value is negative, or if Num is a floating point type where Num'Signed_Zeros
is True and the value is a negatively signed zero, then a minus sign
is included in the integer part. If Exp has the value zero, then the
integer part to be output has as many digits as are needed to represent
the integer part of the value of Item, overriding Fore if necessary,
or consists of the digit zero if the value of Item has no integer part.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>24</FONT></DIV>
<DIV Class="CodeIndented">If Exp has a value greater than zero, then
the integer part to be output has a single digit, which is nonzero except
for the value 0.0 of Item.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>25</FONT></DIV>
<DIV Class="CodeIndented">In both cases, however, if the integer part
to be output has fewer than Fore characters, including any minus sign,
then leading spaces are first output to make up the difference. The number
of digits of the fractional part is given by Aft, or is one if Aft equals
zero. The value is rounded; a value of exactly one half in the last place
is rounded away from zero.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>26</FONT></DIV>
<DIV Class="CodeIndented" Style="margin-bottom: 0.9em">If Exp has the
value zero, there is no exponent part. If Exp has a value greater than
zero, then the exponent part to be output has as many digits as are needed
to represent the exponent part of the value of Item (for which a single
digit integer part is used), and includes an initial sign (plus or minus).
If the exponent part to be output has fewer than Exp characters, including
the sign, then leading zeros precede the digits, to make up the difference.
For the value 0.0 of Item, the exponent has the value zero.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>27</FONT></DIV>
<DIV Class="Examples"><TT><B>procedure</B> Get(From : <B>in</B> String; Item : <B>out</B> Num; Last : <B>out</B> Positive);</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>28</FONT></DIV>
<DIV Class="CodeIndented">Reads a real value from the beginning of the
given string, following the same rule as the Get procedure that reads
a real value from a file, but treating the end of the string as a file
terminator. Returns, in the parameter Item, the value of type Num that
corresponds to the sequence input. Returns in Last the index value such
that From(Last) is the last character read.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>29</FONT></DIV>
<DIV Class="CodeIndented" Style="margin-bottom: 0.9em">The exception
Data_Error is propagated if the sequence input does not have the required
syntax, or if the value obtained is not of the subtype Num.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>30</FONT></DIV>
<DIV Class="Examples"><TT><B>procedure</B> Put(To : <B>out</B> String;<BR>
Item : <B>in</B> Num;<BR>
Aft : <B>in</B> Field := Default_Aft;<BR>
Exp : <B>in</B> Field := Default_Exp);</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>31</FONT></DIV>
<DIV Class="CodeIndented" Style="margin-bottom: 0.9em">Outputs the value
of the parameter Item to the given string, following the same rule as
for output to a file, using a value for Fore such that the sequence of
characters output exactly fills the string, including any leading spaces.
</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>32</FONT></DIV>
<DIV Class="Normal" Style="margin-bottom: 0.4em"> Float_Text_IO is
a library package that is a nongeneric equivalent to Text_IO.Float_IO
for the predefined type Float: </DIV>
<DIV Class="Paranum"><FONT SIZE=-2>33</FONT></DIV>
<DIV Class="Examples"><TT><B>with</B> Ada.Text_IO;<A NAME="I6153"></A><A NAME="I6154"></A><A NAME="I6155"></A><BR>
<B>package</B> Ada.Float_Text_IO <B>is</B> <B>new</B> Ada.Text_IO.Float_IO(Float);</TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>34</FONT></DIV>
<DIV Class="Normal"> For each predefined floating point type, a nongeneric
equivalent to Text_IO.Float_IO is provided, with names such as Ada.Long_Float_Text_IO.</DIV>
<H4 ALIGN=CENTER>Implementation Permissions</H4>
<DIV Class="Paranum"><FONT SIZE=-2>35</FONT></DIV>
<DIV Class="Normal"> An implementation may extend Get [and Put] for
floating point types to support special values such as infinities and
NaNs.</DIV>
<DIV Class="Paranum"><FONT SIZE=-2>35.a</FONT></DIV>
<DIV Class="Annotations"><FONT SIZE=-1><B>Discussion: </B>See also the
similar permission for the Wide_Value attribute in <A HREF="AA-3-5.html">3.5</A>.
</FONT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>36</FONT></DIV>
<DIV Class="Normal"> The implementation of Put need not produce an
output value with greater accuracy than is supported for the base subtype.
The additional accuracy, if any, of the value produced by Put when the
number of requested digits in the integer and fractional parts exceeds
the required accuracy is implementation defined. </DIV>
<DIV Class="Paranum"><FONT SIZE=-2>36.a</FONT></DIV>
<DIV Class="Annotations"><FONT SIZE=-1><B>Discussion: </B>The required
accuracy is thus Num'Base'Digits digits if Num is a floating point subtype.
For a fixed point subtype the required accuracy is a function of the
subtype's Fore, Aft, and Delta attributes. </FONT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>36.b</FONT></DIV>
<DIV Class="Annotations"><FONT SIZE=-1><B>Implementation defined: </B>The
accuracy of the value produced by Put.</FONT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>37</FONT></DIV>
<DIV Class="Normal"> The nongeneric equivalent packages may, but need
not, be actual instantiations of the generic package for the appropriate
predefined type.</DIV>
<DIV Class="NotesHeader"><FONT SIZE=-1>NOTES</FONT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>38</FONT></DIV>
<DIV Class="Notes"><FONT SIZE=-1>30 For an item with a positive
value, if output to a string exactly fills the string without leading
spaces, then output of the corresponding negative value will propagate
Layout_Error.</FONT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>39</FONT></DIV>
<DIV Class="Notes"><FONT SIZE=-1>31 The rules for the Value
attribute (see <A HREF="AA-3-5.html">3.5</A>) and the rules for Get are
based on the same set of formats. </FONT></DIV>
<H4 ALIGN=CENTER>Examples</H4>
<DIV Class="Paranum"><FONT SIZE=-2>40/1</FONT></DIV>
<DIV Class="Examples"><TT><FONT SIZE=-1><I>This paragraph was deleted.</I></FONT><S> </S></TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>41</FONT></DIV>
<DIV Class="Examples"><TT><B>package</B> Real_IO <B>is</B> <B>new</B> Float_IO(Real); <B>use</B> Real_IO;<BR>
--<I> default format used at instantiation, Default_Exp = 3</I></TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>42</FONT></DIV>
<DIV Class="Examples"><TT>X : Real := -123.4567; --<I> digits 8 (see <A HREF="AA-3-5-7.html">3.5.7</A>)</I></TT></DIV>
<DIV Class="Paranum"><FONT SIZE=-2>43</FONT></DIV>
<DIV Class="Examples"><TT>Put(X); <I>-- default format</I> <I>"-1.2345670E+02"</I><BR>
Put(X, Fore => 5, Aft => 3, Exp => 2); <I>-- "bbb-1.235E+2"</I><BR>
Put(X, 5, 3, 0); <I>-- "b-123.457"</I></TT></DIV>
<HR>
<P><A HREF="AA-TOC.html">Contents</A> <A HREF="AA-0-29.html">Index</A> <A HREF="AA-A-10-8.html">Previous</A> <A HREF="AA-A-10-10.html">Next</A> <A HREF="AA-TTL.html">Legal</A></P>
</BODY>
</HTML>
|