source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strsci.html @ 109

Last change on this file since 109 was 109, checked in by pinsard, 18 years ago

modification of savesaxo.sh to fix ticket 17

File size: 17.3 KB
Line 
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>
9    <title>strsci.pro (SAXO Documentation)</title>
10
11   
12    <style type="text/css" media="all">
13     
14/* CSS for all files which appear in the "main" viewing area: overview,
15   directory overviews, warnings, index, search, pro files, source
16   code, help, and etc files. */
17
18/* Link styles --------------------------------------------------------------- */
19
20a { text-decoration: none; }
21
22a:link, a:visited { 
23  color: #660000; 
24  border-bottom: 1px dotted #C0C0F0;   
25}
26
27a:hover, a:focus { 
28  color: #993333; 
29  background: #FFFFCC; 
30  border-bottom: 1px dotted #303099; 
31}
32
33
34/* Main styles --------------------------------------------------------------- */
35
36body {
37  margin: 0;
38  padding: 0;
39  font-size: 10pt;
40  font-family: Verdana, Helvetica, Arial, sans-serif;
41  background-color: #FFFFFF;
42}
43
44p {
45  margin-top: 0.5em;
46  margin-bottom: 0;
47}
48
49#container { margin: 1em; }
50
51code.section { white-space: pre; }
52
53pre.snippet {
54  margin-left: 5%;
55  background: #F0F0F0;
56  border: 1px dashed #999999;
57  width: 43em;
58  padding: 0.5em 0.5em 0.5em 0.5em;
59  white-space: pre;
60}
61
62/* Navbar styles ------------------------------------------------------------- */
63
64#navbar_title {
65  color: #000033;
66  background-color: #F0F0FF;
67  font-family: Arial, Helvetica, sans-serif;
68  padding: 20px 30px;
69  border-bottom: 1px solid #000033;
70}
71
72#navbar_title * {
73  margin: 0;
74  padding: 0;
75}
76
77#navbar_title h1 {
78  letter-spacing: 0.1em;
79  font-variant: small-caps;
80  font-size: 250%;
81  text-indent: -1em;
82  padding-left: 1em; 
83}
84
85#navbar_title h2 {
86  font-size: 110%;
87  font-weight: normal;
88  color: #333399;
89}
90
91#main_navbar table {
92  width: 100%;
93  border-bottom: 1px solid #666699;
94}
95
96#main_navbar td {
97  background: #CCCCFF;
98  font-size: 80%;
99  font-weight: bold;
100  font-family: Arial, Helvetica, sans-serif;
101  border-top: 3px solid #CCCCFF;
102  border-bottom: 3px solid #CCCCFF;
103  padding-left: 6px;
104  padding-right: 6px;
105  margin: 0;
106}
107
108#main_navbar td#selected {
109  background: #CCCCFF;
110  font-size: 80%;
111  font-weight: bold;
112  font-family: Arial, Helvetica, sans-serif;
113  border-top: 3px solid #333399;
114  border-bottom: 3px solid #CCCCFF;
115  padding-left: 6px;
116  padding-right: 6px;
117  margin: 0;
118}
119
120#main_navbar td#flexible {
121  width: 100%;
122  text-align: right;
123  padding-right: 1em;
124  background: #CCCCFF;
125  font-size: 70%;
126  font-weight: normal;
127  font-family: Arial, Helvetica, sans-serif;
128  text-transform: uppercase;
129  border-top: 3px solid #CCCCFF;
130  border-bottom: 3px solid #CCCCFF;
131}
132
133#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
134
135#main_navbar a:hover, #main_navbar a:focus {
136  color: #FFFF66;
137  background: #CCCCFF;
138  border-bottom: 1px none #606099; 
139  border: 0;
140}
141
142#secondary_navbar {
143  font-size: 80%;
144  font-weight: normal;
145  font-family: Arial, Helvetica, sans-serif;
146  margin-top: 4px;
147  margin-left: 20px;
148  white-space: nowrap;
149}
150
151
152/* Tagline and footer styles ------------------------------------------------- */
153
154div#tagline {
155  margin-top: 6px;
156  border-top: 1px dotted lightsteelblue;
157  padding-top: 6px;
158  font-size: 66%;
159  font-style: italic;
160}
161
162div#footer {
163  margin-top: 6px;
164  border-top: 1px dotted lightsteelblue;
165  padding-top: 6px;
166  font-size: 66%;
167  font-style: italic;
168}
169
170/* Basic data presenation styles -------------------------------------------- */
171
172.index_letter { 
173  font-size: 300%;
174  font-weight: bold;
175  color: #000066; 
176  margin: 0.5em 0 0 -0.1em;
177}
178
179h1, h2, h3, h4 {
180  font-weight: normal;
181  color: #3333CC;
182}
183
184h1 {
185  padding-top: 0.75em;
186  font-size: 160%;
187}
188
189h2 {
190  padding-top: 1em;
191  font-size: 120%;
192  }
193
194h3 {
195  padding-top: 0.75em;
196  margin-bottom: 0.25em;
197  font-size: 100%;
198}
199
200h4 {
201  padding: 0;
202  margin: 0.5em 0 0 0;
203  font-size: 80%;
204}
205
206table.basic {
207  empty-cells: show;
208  margin: 1.5em 1em 0 1em;
209  border: 1px dotted #CFCFFF;
210  font-size: 80%;
211}
212
213table.basic th {
214  background-color: #F0F0FF;
215  font-weight: bold;
216  text-align: left;
217  padding: 4px 1em 4px 4px;
218  border-bottom: 1px dotted #666699;
219}
220
221table.basic td {
222  vertical-align: top;
223  padding: 4px 1em 4px 4px;
224}
225
226dd {
227  margin-bottom: 0.25em;
228  font-size: 80%;
229}
230
231
232/* Warnings styles ----------------------------------------------------------- */
233
234
235#todo dl, #bugs dl { 
236  margin: 0 0 0 1.5em;
237  font-size: 80%;
238}
239
240#todo dd, #bugs dd { 
241  margin-left: 3em; 
242  font-size: 100%;
243}
244
245#undoc table, #obsolete table, #statistics table {
246  width: 80%;
247  margin-left: 2em;
248}
249
250#undoc td, #obsolete td, #statistics td { 
251  padding: 0 0 0 0;
252  font-size: 80%;
253  white-space: nowrap;
254}
255
256#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
257
258#undoc td.docstat, #statistics td.stat { 
259  width: 50%;
260  text-align: right;
261}
262
263#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
264
265#undoc td.notdoc, #statistics td.warning { color: #993333; }
266
267/* File + routine styles ----------------------------------------------------- */
268
269h1.directory { 
270  padding: 1em 0 0 0;
271  margin: 0;
272  font-size: 66%;
273}
274
275h1.directory a { border-bottom: 0; }
276
277h2.pro_file { 
278  padding: 0;
279  margin: 0;
280  font-size: 140%;
281}
282
283div#file_attr {
284  padding: 0 1em 0 1em;
285  margin: 1em;
286  background: #F6F6F6;
287  border: 1px dotted #999999;
288}
289
290div#file_attr dt {
291  font-size: 80%;
292  font-weight: bold;
293}
294
295div#file_attr dd {
296  font-size: 80%;
297}
298
299div#class_diagram { 
300  padding: 1em 0 1em 0; 
301  white-space: pre;
302  font-family: 'Courier New';
303}
304
305table#sav_attr { 
306  font-size: 90%; 
307  margin: 1em; 
308  padding: 1em 1em 1em 1em;
309  background: #F6F6F6;
310  border: 1px dotted #999999;
311}
312
313table#sav_attr th { text-align: left; }
314
315table#sav_attr td { vertical-align: top; padding-right: 2em; }
316
317table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
318
319p.sav_warning { margin-left: 4em; font-family: 80%; }
320
321table.variables { 
322  font-family: 'Courier New', monospace; 
323  font-size: 80%; 
324  text-indent: -2em; 
325  padding-left: 2em; 
326}
327
328table.variables td.image { width: 64px; }
329
330div#file_comments { 
331  margin: 2em;
332  font-size: 80%;
333}
334
335
336div.field_summary {
337  padding: 0 1em 0 1em;
338  margin: 1em;
339  background: #FFFFF0;
340  border: 1px dotted #C0C000;
341}
342
343div#routine_summary { 
344  padding: 0 1em 0 1em;
345  margin: 1em;
346  background: #F0F0FF;
347  border: 1px dotted #9999FF;
348}
349
350div.field_summary h2, div#routine_summary h2 { 
351  padding: 0.5em 0 0 0;
352  margin: 0;
353}
354
355div.field_summary table, div.field_summary p { 
356  margin: 1em 1em;
357}
358
359div.field_summary td.name { 
360  vertical-align: top;
361  padding-bottom: 0.25em;
362  color: #3333CC;
363}
364
365div.field_summary span.field_type { 
366  font-weight: normal;
367  font-size: 80%;
368  color: black;
369}
370
371div.field_summary td.comments { 
372  vertical-align: top;
373  padding-left: 2em;
374  font-size: 80%;
375}
376
377p.commaList { 
378  margin: 1em 1em 1em 1em;
379}
380
381span.warning { 
382  color: #CC6633;
383  font-weight: bold;
384  font-size: 66%;
385  text-transform: uppercase;
386}
387
388span.categories { 
389  color: #006633;
390  font-weight: bold;
391  font-size: 66%;
392  text-transform: uppercase;
393}
394
395span.undoc { 
396  color: #FF6633;
397  font-weight: bold;
398  font-size: 80%;
399  text-transform: uppercase;
400}
401
402span.attr { 
403  color: #006633;
404  font-weight: bold;
405  font-size: 80%;
406  text-transform: uppercase;
407}
408
409span.value { 
410  color: #006633;
411  font-weight: normal;
412  text-transform: none;
413}
414
415a.top { 
416  font-weight: bold;
417  font-size: 66%;
418  text-transform: uppercase;
419  float: right;
420}
421
422span.result { 
423  font-family: Verdana, Arial, Helvetica, sans-serif;
424  font-style: italic;
425  font-size: 80%;
426}
427
428div#routine_summary p, div.routine_details p.header { 
429  padding-top: 0.5em;
430  margin-left: 1.5em;
431  text-indent: -1.5em;
432  font-family: 'Courier New', monospace;
433}
434
435div.routine_details { 
436  padding: 0.5em 1em 0.5em 1em;
437  margin: 1em;
438  border: 1px dotted #CCCCCC;
439}
440
441div.routine_details h2 { 
442  padding-top: 0;
443  margin-top: 0;
444}
445
446div.routine_details div.value { 
447  margin: 0 1em 0 1em;
448  font-size: 80%;
449}
450
451div.routine_details div.comments { 
452  font-size: 80%;
453  margin: 0.75em 1em 1em 1em;
454}
455
456div.routine_details div.preformat { 
457  white-space: pre;
458}
459
460table.statistics { 
461  font-size: 80%;
462  margin-left: 1em;
463}
464
465table.statistics td { 
466  padding: 0 2em 0 0;
467}
468
469/* Overview styles ----------------------------------------------------------- */
470
471div.overview { 
472  width: 100%;
473  margin-top: 1em;
474  clear: both;
475}
476
477div.overview table {
478  empty-cells: show;
479  font-size: 90%;
480  margin: 1em 1em 1em 1em;
481  padding: 1em 0.5em 1em 0.5em;
482  background: #F6F6F6;
483  border: 1px dotted #999999;
484}
485
486div.overview td {
487  padding: 3px 1em 3px 1em;
488}
489
490div.overview td.dir {
491  width: 1%;
492  vertical-align: top;
493  text-align: right;
494  padding-right: 1em;
495}
496
497
498/* Navigation list styles for tree structures -------------------------------- */
499
500#tree {
501  text-align: left;
502  font-size: 90%;
503  margin: 0.75em 0 0.75em 0;
504  padding: 0;
505}
506
507#tree ul {
508  text-align: left;
509  margin: 0;
510  padding: 0;
511}
512
513#tree li {
514  margin: 0 0 0 15px;
515  padding: 0;
516  list-style-type: none;
517}
518
519#tree .symbols {
520  float: left;
521  width: 12px;
522  height: 1em;
523  padding-left: 4px;
524  background-position: 0 100%;
525  background-repeat: no-repeat;
526}
527
528/* Search styles ------------------------------------------------------------- */
529
530input.writein { 
531  padding-left: 0.5em;
532  border: 1px solid #CCCCCC;
533  font-family: 'Courier New';
534  background: #FFFFF3;
535}
536
537#search form { 
538  margin-left: 2em;
539}
540
541#search table { 
542  margin: 1em 1em 0 2em;
543  padding: 1em 2em 1em 2em;
544  background: #F6F6F6;
545  border: 1px dotted #999999;
546}
547
548#search tr { 
549  text-align: center;
550}
551
552#search td { 
553  font-size: 80%; 
554  text-align: left;
555}
556
557#search td * { 
558  vertical-align: middle;
559}
560
561#search p { 
562  font-size: 66%;
563  margin: 0 3em 2em 3em;
564}
565
566/* Help styles --------------------------------------------------------------- */
567
568div.toc { 
569  padding: 0 1em 0 1em;
570  margin: 1em;
571  background: #F0F0FF;
572  border: 1px dotted #9999FF; 
573  width: 19em;
574}
575
576div.right { 
577  float: right;
578  width: 22em;
579}
580
581ol.toc { 
582  list-style-type: upper-roman;
583}
584
585ol.toc ol { 
586  padding-left: 3em;
587  margin-left: 0;
588  list-style-type: lower-alpha;
589}
590
591dl.variables dt { font-size: 80%; }
592dl.variables dd { margin-bottom: 0.5em; }
593
594    </style>
595    <style type="text/css" media="print">
596      #navbar_title { 
597  background-color: #FFFFFF; 
598}
599
600#main_navbar td {
601  background: #FFFFFF;
602  border-top: 0.25em solid #FFFFFF;
603  border-bottom: 0.25em solid #FFFFFF;
604}
605
606#main_navbar td#selected {
607  background: #FFFFFF;
608  border-top: 0.25em solid #333399;
609  border-bottom: 0.25em solid #FFFFFF;
610}
611
612#main_navbar td#flexible {
613  background: #FFFFFF;
614  border-top: 0.25em solid #FFFFFF;
615  border-bottom: 0.25em solid #FFFFFF;
616}
617
618#secondary_navbar {
619  display: none;
620}
621
622    </style>
623   
624
625    <script type="text/javascript">
626      function setTitle() {
627        parent.document.title="strsci.pro (SAXO Documentation)";
628      }
629    </script>
630  </head>
631
632  <body onload="setTitle();">
633
634    <div id="navbar_title">
635  <h1>SAXO Documentation</h1>
636</div>
637
638
639<div id="main_navbar">
640
641  <table cellspacing="0">
642    <tr>
643     
644      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
645     
646
647     
648      <td >Directory</td>
649     
650
651     
652      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
653     
654
655     
656      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
657     
658
659     
660      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
661     
662
663      <td id="selected">File</td>
664
665     
666      <td >Source</td>
667     
668
669     
670      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
671     
672
673      <td >Etc</td>
674
675      <td id="flexible">Developer&nbsp;documentation</td>
676    </tr>
677  </table>
678
679</div>
680
681<div id="secondary_navbar">
682
683<a href="strright.html">&lt;&lt;prev file</a> | <a href="strtok.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strsci.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
684
685</div>
686
687
688    <div id="container">
689
690      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/STRING/</a></h1>
691      <h2 class="pro_file">strsci.pro</h2>
692
693      <div id="file_attr">
694        <dl>
695        </dl>
696      </div>
697
698      <div id="file_comments"></div>
699
700     
701
702     
703
704     
705
706     
707
708      <div id="routine_details">
709       
710
711        <div class="routine_details" id="_StrSci">
712
713          <h2><a class="top" href="#container">top</a>StrSci </h2>
714       
715          <p class="header">
716            <span class="result">result = </span>StrSci(<span class="result"><a href="#_StrSci_param_Data">Data</a></span>, <a href="#_StrSci_keyword_Format">Format</a>=<span class="result">Format</span>, <a href="#_StrSci_keyword_POT_Only">POT_Only</a>=<span class="result">POT_Only</span>, <a href="#_StrSci_keyword_MANTISSA_ONLY">MANTISSA_ONLY</a>=<span class="result">MANTISSA_ONLY</span>, <a href="#_StrSci_keyword_SHORT">SHORT</a>=<span class="result">SHORT</span>, <a href="#_StrSci_keyword_TRIM">TRIM</a>=<span class="result">TRIM</span>)</p>
717       
718          <div class="comments">
719 NAME:
720        STRSCI (function)
721
722 PURPOSE:                                                 
723        Given a number, returns a string of that          B
724        number in scientific notation format ( e.g. A x 10  )
725
726 CATEGORY:
727        String Utilities
728
729 CALLING SEQUENCE:
730        Result = STRSCI( DATA [,keywords] )
731
732 INPUTS:
733        DATA      -> A floating point or integer number to be
734                     converted into a power of 10.
735
736 KEYWORD PARAMETERS:
737        FORMAT    -> The format specification used in the string
738                     conversion for the mantissa (i.e. the
739                     "A" of "A x 10^B").  Default is '(f12.2)'. 
740
741        /POT_ONLY -> Will return only the "power of 10" part of the
742                     string (i.e. the "10^B").  Default is to return
743                     the entire string (e.g. "A x 10^B" )
744
745        /MANTISSA_ONLY -> return only mantissa of the string
746
747        /SHORT -> return 10^0 as '1' and 10^1 as '10'
748
749        /TRIM -> don't insert blanks (i.e. return Ax10^B)
750
751 OUTPUTS:
752        None
753
754 SUBROUTINES:
755        None
756
757 REQUIREMENTS:
758        None
759
760 NOTES:
761        This function does not "evaluate" the format statement thoroughly
762        which can result in somewhat quirky strings. Example:
763        print,strsci(-9.999) results in -10.0x10^0 instead of -1.0x10^1.
764
765        Need a better symbol than the 'x' for the multiplier...
766
767 EXAMPLE:
768        Result = STRSCI( 2000000, format='(i1)' )
769        print, result               
770        ;                                                     6
771        ;     prints 2 x 10!u6!n, which gets plotted as 2 x 10
772       
773        Result = STRSCI( -0.0001 )
774        print, result
775        ;                                                            4
776        ;     prints -1.00 x 10!u-4!n, which gets plotted as 1.00 x 10
777
778        Result = STRSCI( 0d0, format='(f13.8)' )
779        print, result
780        ;
781        ;     prints, 0.00000000
782 
783
784 MODIFICATION HISTORY:
785        bmy, 28 May 1998: VERSION 1.00            B
786           - now returns string of the form A x 10
787        mgs, 29 May 1998:
788           - bug fix: now allows negative numbers
789           - keyword MANTISSA_ONLY added
790           - default format changed to f12.2
791        bmy, 02 Jun 1998:
792           - renamed to STRSCI ("STRing SCIentific notation"),
793        mgs, 03 Jun 1998:
794           - added TRIM keyword
795        mgs, 22 Sep 1998:
796           - added SHORT keyword
797           - modified handling of TRIM keyword
798        mgs, 24 Sep 1998:
799           - bug fix with SHORT flag
800        bmy & mgs, 02 Jun 1999:
801           - now can handle DATA=0.0 correctly
802           - updated comments
803        mgs, 03 Jun 1999:
804           - can now also handle values lt 1 ;-)
805           - and doesn't choke on arrays
806</div>
807
808         
809
810         
811            <h3>Parameters</h3>
812       
813           
814            <h4 id="_StrSci_param_Data">Data&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
815             
816             
817             
818             
819             
820             
821             
822             
823            </h4>
824       
825          <div class="comments"></div>
826           
827
828         
829
830         
831
832            <h3>Keywords</h3>
833           
834            <h4 id="_StrSci_keyword_Format">Format&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
835             
836             
837             
838             
839             
840             
841             
842             
843            </h4>
844       
845            <div class="comments"></div>
846           
847            <h4 id="_StrSci_keyword_POT_Only">POT_Only&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
848             
849             
850             
851             
852             
853             
854             
855             
856            </h4>
857       
858            <div class="comments"></div>
859           
860            <h4 id="_StrSci_keyword_MANTISSA_ONLY">MANTISSA_ONLY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
861             
862             
863             
864             
865             
866             
867             
868             
869            </h4>
870       
871            <div class="comments"></div>
872           
873            <h4 id="_StrSci_keyword_SHORT">SHORT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
874             
875             
876             
877             
878             
879             
880             
881             
882            </h4>
883       
884            <div class="comments"></div>
885           
886            <h4 id="_StrSci_keyword_TRIM">TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
887             
888             
889             
890             
891             
892             
893             
894             
895            </h4>
896       
897            <div class="comments"></div>
898           
899         
900
901         
902         
903         
904         
905         
906         
907         
908         
909         
910         
911         
912         
913       
914         
915         
916         
917         
918         
919         
920         
921       
922         
923       
924        </div>
925       
926      </div>
927
928     
929
930      <div id="tagline">Produced by IDLdoc 2.0.</div>
931
932    </div>
933
934  </body>
935</html>
Note: See TracBrowser for help on using the repository browser.