- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strsci.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Given a number, returns a string of that B 700 number in scientific notation format ( e.g. A x 10 ) 701 </div> 699 702 700 703 … … 711 714 <div class="routine_details" id="_StrSci"> 712 715 713 <h2><a class="top" href="#container">top</a>StrSci </h2> 716 <h2><a class="top" href="#container">top</a>StrSci <span class="categories"> 717 String Utilities 718 </span></h2> 714 719 715 720 <p class="header"> … … 717 722 718 723 <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: 724 </div> 725 726 727 728 729 <h3>Parameters</h3> 730 731 732 <h4 id="_StrSci_param_Data">Data 733 <span class="attr">in</span> 734 735 736 <span class="attr">required</span> 737 738 739 740 741 </h4> 742 743 <div class="comments"> 744 A floating point or integer number to be 745 converted into a power of 10. 746 </div> 747 748 749 750 751 752 753 <h3>Keywords</h3> 754 755 <h4 id="_StrSci_keyword_Format">Format 756 757 758 759 760 761 762 763 764 </h4> 765 766 <div class="comments"> 767 The format specification used in the string 768 conversion for the mantissa (i.e. the 769 "A" of "A x 10^B"). Default is '(f12.2)'. 770 </div> 771 772 <h4 id="_StrSci_keyword_POT_Only">POT_Only 773 774 775 776 777 778 779 780 781 </h4> 782 783 <div class="comments"> 784 Will return only the "power of 10" part of the 785 string (i.e. the "10^B"). Default is to return 786 the entire string (e.g. "A x 10^B" ) 787 </div> 788 789 <h4 id="_StrSci_keyword_MANTISSA_ONLY">MANTISSA_ONLY 790 791 792 793 794 795 796 797 798 </h4> 799 800 <div class="comments"> 801 return only mantissa of the string 802 </div> 803 804 <h4 id="_StrSci_keyword_SHORT">SHORT 805 806 807 808 809 810 811 812 813 </h4> 814 815 <div class="comments"> 816 return 10^0 as '1' and 10^1 as '10' 817 </div> 818 819 <h4 id="_StrSci_keyword_TRIM">TRIM 820 821 822 823 824 825 826 827 828 </h4> 829 830 <div class="comments"> 831 don't insert blanks (i.e. return Ax10^B) 832 </div> 833 834 835 836 <h3>Examples</h3><div class="preformat"> 768 837 Result = STRSCI( 2000000, format='(i1)' ) 769 838 print, result … … 781 850 ; prints, 0.00000000 782 851 783 784 MODIFICATION HISTORY: 852 </div> 853 <h3>Version history</h3> 854 855 <h4>Version</h4><div class="preformat"> 856 $Id: strsci.pro 134 2006-07-07 10:19:08Z navarro $ 857 </div> 858 <h4>History</h4><div class="preformat"> 785 859 bmy, 28 May 1998: VERSION 1.00 B 786 860 - now returns string of the form A x 10 … … 805 879 - and doesn't choke on arrays 806 880 </div> 807 808 809 810 811 <h3>Parameters</h3> 812 813 814 <h4 id="_StrSci_param_Data">Data 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 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 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 861 862 863 864 865 866 867 868 869 </h4> 870 871 <div class="comments"></div> 872 873 <h4 id="_StrSci_keyword_SHORT">SHORT 874 875 876 877 878 879 880 881 882 </h4> 883 884 <div class="comments"></div> 885 886 <h4 id="_StrSci_keyword_TRIM">TRIM 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 881 882 883 <h3>Known issues</h3> 884 885 886 887 <h4>Restrictions</h4><div class="preformat"> 888 This function does not "evaluate" the format statement thoroughly 889 which can result in somewhat quirky strings. Example: 890 print,strsci(-9.999) results in -10.0x10^0 instead of -1.0x10^1. 891 892 Need a better symbol than the 'x' for the multiplier... 893 </div> 913 894 914 895
Note: See TracChangeset
for help on using the changeset viewer.
