aboutsummaryrefslogtreecommitdiff
path: root/math/slalib/doc/intin.hlp
blob: f0b0c8eed85454979718065bf6e161a4be96f75d (plain) (blame)
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
.help intin Jun99 "Slalib Package"
.nf

      SUBROUTINE slINTI (STRING, NSTRT, IRESLT, JFLAG)

     - - - - - -
      I N T I
     - - - - - -

  Convert free-format input into an integer

  Given:
     STRING     c     string containing number to be decoded
     NSTRT      i     pointer to where decoding is to start
     IRESLT     i     current value of result

  Returned:
     NSTRT      i      advanced to next number
     IRESLT     i      result
     JFLAG      i      status: -1 = -OK, 0 = +OK, 1 = null, 2 = error

  Called:  slICHI

  Notes:

     1     The reason INTIN has separate OK status values for +
           and - is to enable minus zero to be detected.   This is
           of crucial importance when decoding mixed-radix numbers.
           For example, an angle expressed as deg, arcmin, arcsec
           may have a leading minus sign but a zero degrees field.

     2     A TAB is interpreted as a space.

     3     The basic format is the sequence of fields #^, where
           # is a sign character + or -, and ^ means a string of
           decimal digits.

     4     Spaces:

             .  Leading spaces are ignored.

             .  Spaces between the sign and the number are allowed.

             .  Trailing spaces are ignored;  the first signifies
                end of decoding and subsequent ones are skipped.

     5     Delimiters:

             .  Any character other than +,-,0-9 or space may be
                used to signal the end of the number and terminate
                decoding.

             .  Comma is recognized by INTIN as a special case;  it
                is skipped, leaving the pointer on the next character.
                See 9, below.

     6     The sign is optional.  The default is +.

     7     A "null result" occurs when the string of characters being
           decoded does not begin with +,- or 0-9, or consists
           entirely of spaces.  When this condition is detected, JFLAG
           is set to 1 and IRESLT is left untouched.

     8     NSTRT = 1 for the first character in the string.

     9     On return from INTIN, NSTRT is set ready for the next
           decode - following trailing blanks and any comma.  If a
           delimiter other than comma is being used, NSTRT must be
           incremented before the next call to INTIN, otherwise
           all subsequent calls will return a null result.

     10    Errors (JFLAG=2) occur when:

             .  there is a + or - but no number;  or

             .  the number is greater than BIG (defined below).

     11    When an error has been detected, NSTRT is left
           pointing to the character following the last
           one used before the error came to light.

     12    See also FLOTIN and DFLTIN.

  P.T.Wallace   Starlink   27 April 1998

  Copyright (C) 1998 Rutherford Appleton Laboratory
  Copyright (C) 1995 Association of Universities for Research in Astronomy Inc.

.fi
.endhelp