source: trunk/SRC/Documentation/idldoc_html_output/Calendar/leapyr.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 4.6 KB
RevLine 
[89]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
[104]9    <title>leapyr.pro (SAXO Documentation)</title>
[89]10
11   
[191]12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="leapyr.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Calendar//leapyr.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
[189]74<a href="julday.html">&lt;&lt;prev file</a> | <a href="monthname.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="leapyr.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Calendar/</a></h1>
[89]82      <h2 class="pro_file">leapyr.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 determine whether the input year is a leap year or not
[97]91 Very useful for finding number of days in a year.
92 eg. NUM_DAYS_IN_YR = 365 + leapyr(year)
93</div>
[89]94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_leapyr">
107
[242]108          <h2><a class="top" href="#container">top</a>leapyr <span class="categories">
[157]109 Calendar
[93]110</span></h2>
[89]111       
112          <p class="header">
113            <span class="result">result = </span>leapyr(<span class="result"><a href="#_leapyr_param_year">year</a></span>)</p>
114       
[93]115          <div class="comments">
116</div>
[89]117
[242]118          <h3>Return value</h3><div class="preformat">
[138]119 0 then not a leap year, 1 then year is a leap year
120 with the same number of elements than year.
[93]121</div>
122
[89]123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_leapyr_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[93]128              <span class="attr">in</span>
[89]129             
130             
[93]131              <span class="attr">required</span>
[89]132             
[234]133              <span class="attr">type:</span> <span class="value"> scalar or array</span>
[89]134             
135             
136            </h4>
137       
[234]138          <div class="comments">
139 year to be tested as a leap year.
[93]140</div>
[89]141           
142
143         
144
145         
146
[138]147          <h3>Examples</h3><div class="preformat">
[402]148   IDL> result = leapyr(2000)
[93]149</div>
150          <h3>Version history</h3>
[89]151         
[234]152          <h4>Version</h4><div class="preformat">
[402]153 $Id: leapyr.pro 371 2008-08-07 09:32:02Z pinsard $
[118]154</div>
[138]155          <h4>History</h4><div class="preformat">
[93]156
157 Originally Written by: Trevor Harris, Physics Dept., University of Adelaide,
15820/09/88
159
[138]160 November 2004: correction for century years... S. Masson;
[93]161
[138]162 Every year divisible by 4 is a leap year.
163 But every year divisible by 100 is NOT a leap year
164 Unless the year is also divisible by 400, then it is still a
165 leap year.
166 This means that year 1800, 1900, 2100, 2200, 2300 and 2500 are
167 NOT leap years, while year 2000 and 2400 are leap years.
168 + supress the automatic change 89 -> 1989
[93]169
[138]170 June 2005 update for new commons, Sebastien Masson.
[93]171</div>
[89]172         
173         
174         
175         
176         
177         
178         
179       
[93]180          <h3>Other attributes</h3>
[89]181         
182         
[234]183          <h4>Uses routines</h4><div class="preformat">
[402]184 <a href="..//Commons/cm_4cal.html">cm_4cal</a>
[93]185</div>
[89]186         
187         
188         
189       
[163]190          <h3>Statistics</h3>
191          <table class="statistics">
192            <tr><td>McCabe cyclic</td><td>           4</td></tr>
193            <tr><td>McCabe essential</td><td>           1</td></tr>
194            <tr><td>McCabe modular design</td><td>           1</td></tr>
195          </table>
[89]196         
197       
198        </div>
199       
200      </div>
201
202     
203
204      <div id="tagline">Produced by IDLdoc 2.0.</div>
205
206    </div>
207
208  </body>
[249]209</html>
Note: See TracBrowser for help on using the repository browser.