octave: libinterp/corefcn/ls-oct-text.cc annotate

annotate libinterp/corefcn/ls-oct-text.cc @ 23556:31b1ef1ee585

Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. * ls-oct-text.cc (Vsave_precision): Change default to 17 digits. * ls-oct-text.cc (Fsave_precision): Add explanation of suitable values to docstring.

author	Rik <rik@octave.org>
date	Wed, 07 Jun 2017 12:29:23 -0700
parents	a41fdb801db6
children	194eb4bd202b

rev	line source
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	1 /*
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	2
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 1996-2017 John W. Eaton
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	4
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	6
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	8 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	9 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	10 (at your option) any later version.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	11
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 GNU General Public License for more details.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	16
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6974 diff changeset	18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6974 diff changeset	19 <http://www.gnu.org/licenses/>.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	20
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	21 */
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	22
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	23 // Author: John W. Eaton.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	24
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	25 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	26 # include "config.h"
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	27 #endif
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	28
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	29 #include <cstring>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	30 #include <cctype>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	31
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	32 #include <fstream>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	33 #include <iomanip>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	34 #include <iostream>
5765 7ba9ad1fec11 [project @ 2006-04-17 05:05:15 by jwe] jwe parents: 5754 diff changeset	35 #include <sstream>
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	36 #include <string>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	37
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	38 #include "byte-swap.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	39 #include "data-conv.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	40 #include "file-ops.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	41 #include "glob-match.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	42 #include "lo-mappers.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	43 #include "mach-info.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	44 #include "oct-env.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	45 #include "oct-time.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	46 #include "quit.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	47 #include "str-vec.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	48
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	49 #include "Cell.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	50 #include "defun.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	51 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21021 diff changeset	52 #include "errwarn.h"
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	53 #include "load-save.h"
8946 e7e928088e90 fix CRLF issues with text-mode reading in windows when loading ascii data Benjamin Lindner <lindnerb@users.sourceforge.net> parents: 8920 diff changeset	54 #include "ls-ascii-helper.h"
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	55 #include "ls-oct-text.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20853 diff changeset	56 #include "ovl.h"
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	57 #include "oct-map.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	58 #include "ov-cell.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	59 #include "pager.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	60 #include "pt-exp.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	61 #include "unwind-prot.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	62 #include "utils.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	63 #include "variables.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	64 #include "version.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	65 #include "dMatrix.h"
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	66
23556 31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	67 // The number of decimal digits to use when writing ASCII data.
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	68 // 17 is the minimum necessary for lossless save/restore of IEEE-754 doubles.
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	69 static int Vsave_precision = 17;
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	70
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	71 // Functions for reading octave format text data.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	72
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	73 // Extract a KEYWORD and its value from stream IS, returning the
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	74 // associated value in a new string.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	75 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	76 // Input should look something like:
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	77 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	78 // [%#][ \t]keyword[ \t]:[ \t]string-value[ \t]\n
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	79
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	80 std::string
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	81 extract_keyword (std::istream& is, const char *keyword, const bool next_only)
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	82 {
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	83 std::string retval;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	84
7744 14b841c47a5f handle load/save for handles to built-in functions John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	85 int ch = is.peek ();
14b841c47a5f handle load/save for handles to built-in functions John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	86 if (next_only && ch != '%' && ch != '#')
14b841c47a5f handle load/save for handles to built-in functions John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	87 return retval;
14b841c47a5f handle load/save for handles to built-in functions John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	88
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	89 char c;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	90 while (is.get (c))
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	91 {
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	92 if (c == '%' \|\| c == '#')
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	93 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	94 std::ostringstream buf;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	95
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	96 while (is.get (c) && (c == ' ' \|\| c == '\t' \|\| c == '%' \|\| c == '#'))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	97 ; // Skip whitespace and comment characters.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	98
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	99 if (isalpha (c))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	100 buf << c;
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	101
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	102 while (is.get (c) && isalpha (c))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	103 buf << c;
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	104
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	105 std::string tmp = buf.str ();
21021 a5b99b09f8fd maint: Use comparison operators rather than compare() for strings. Rik <rik@octave.org> parents: 21017 diff changeset	106 bool match = (tmp.substr (0, strlen (keyword)) == keyword);
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	107
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	108 if (match)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	109 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	110 std::ostringstream value;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	111 while (is.get (c) && (c == ' ' \|\| c == '\t' \|\| c == ':'))
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	112 ; // Skip whitespace and the colon.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	113
14861 f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory Rik <octave@nomad.inbox5.com> parents: 14846 diff changeset	114 is.putback (c);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	115 retval = read_until_newline (is, false);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	116 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	117 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	118 else if (next_only)
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	119 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	120 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	121 skip_until_newline (is, false);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	122 }
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	123 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	124
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	125 int len = retval.length ();
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	126
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	127 if (len > 0)
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	128 {
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	129 while (len)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	130 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	131 c = retval[len-1];
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	132
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	133 if (c == ' ' \|\| c == '\t')
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	134 len--;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	135 else
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	136 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	137 retval.resize (len);
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	138 break;
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	139 }
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	140 }
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	141 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	142
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	143 return retval;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	144 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	145
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	146 // Extract one value (scalar, matrix, string, etc.) from stream IS and
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	147 // place it in TC, returning the name of the variable. If the value
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	148 // is tagged as global in the file, return TRUE in GLOBAL.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	149 //
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	150 // Each type supplies its own function to load the data, and so this
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	151 // function is extensible.
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	152 //
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	153 // FILENAME is used for error messages.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	154 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	155 // The data is expected to be in the following format:
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	156 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	157 // The input file must have a header followed by some data.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	158 //
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	159 // All lines in the header must begin with a '#' character.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	160 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	161 // The header must contain a list of keyword and value pairs with the
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	162 // keyword and value separated by a colon.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	163 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	164 // Keywords must appear in the following order:
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	165 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	166 // # name: <name>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	167 // # type: <type>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	168 // # <info>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	169 //
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	170 // Where, for the built in types are:
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	171 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	172 // <name> : a valid identifier
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	173 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	174 // <type> : <typename>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	175 // \| global <typename>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	176 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	177 // <typename> : scalar
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	178 // \| complex scalar
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	179 // \| matrix
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	180 // \| complex matrix
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	181 // \| bool
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	182 // \| bool matrix
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	183 // \| string
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	184 // \| range
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	185 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	186 // <info> : <matrix info>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	187 // \| <string info>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	188 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	189 // <matrix info> : # rows: <integer>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	190 // : # columns: <integer>
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	191 //
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	192 // <string info> : # elements: <integer>
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	193 // : # length: <integer> (once before each string)
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	194 //
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21724 diff changeset	195 // For backward compatibility the type "string array" is treated as a
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21724 diff changeset	196 // "string" type. Also "string" can have a single element with no elements
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	197 // line such that
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	198 //
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	199 // <string info> : # length: <integer>
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	200 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	201 // Formatted ASCII data follows the header.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	202 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	203 // Example:
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	204 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	205 // # name: foo
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	206 // # type: matrix
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	207 // # rows: 2
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	208 // # columns: 2
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	209 // 2 4
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	210 // 1 3
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	211 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	212 // Example:
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	213 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	214 // # name: foo
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	215 // # type: string
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	216 // # elements: 5
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	217 // # length: 4
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	218 // this
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	219 // # length: 2
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	220 // is
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	221 // # length: 1
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	222 // a
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	223 // # length: 6
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	224 // string
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	225 // # length: 5
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	226 // array
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	227 //
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	228 // FIXME: This format is fairly rigid, and doesn't allow for arbitrary comments.
c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	229 // Someone should fix that. It does allow arbitrary types however.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	230
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	231 // Ugh. The signature of the compare method is not standard in older
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	232 // versions of the GNU libstdc++. Do this instead:
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	233
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	234 #define SUBSTRING_COMPARE_EQ(s, pos, n, t) (s.substr (pos, n) == t)
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	235
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	236 std::string
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	237 read_text_data (std::istream& is, const std::string& filename, bool& global,
22407 34ce5be04942 maint: Style check C++ code in libinterp/. Rik <rik@octave.org> parents: 22323 diff changeset	238 octave_value& tc, octave_idx_type count)
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	239 {
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	240 // Read name for this entry or break on EOF.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	241
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	242 std::string name = extract_keyword (is, "name");
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	243
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	244 if (name.empty ())
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	245 {
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	246 if (count == 0)
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	247 error ("load: empty name keyword or no data found in file '%s'",
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	248 filename.c_str ());
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	249
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 21014 diff changeset	250 return "";
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	251 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	252
7744 14b841c47a5f handle load/save for handles to built-in functions John W. Eaton <jwe@octave.org> parents: 7336 diff changeset	253 if (! (name == ".nargin." \|\| name == ".nargout."
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	254 \|\| name == CELL_ELT_TAG \|\| valid_identifier (name)))
20835 14cd86258b3d use 'invalid' instead of 'bogus' in source files John W. Eaton <jwe@octave.org> parents: 20831 diff changeset	255 error ("load: invalid identifier '%s' found in file '%s'",
20741 a5ab31b52ae8 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20447 diff changeset	256 name.c_str (), filename.c_str ());
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	257
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	258 // Look for type keyword.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	259
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	260 std::string tag = extract_keyword (is, "type");
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	261
20981 c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	262 if (tag.empty ())
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	263 error ("load: failed to extract keyword specifying value type");
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	264
20981 c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	265 std::string typ;
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	266 size_t pos = tag.rfind (' ');
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	267
20981 c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	268 if (pos != std::string::npos)
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	269 {
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	270 global = SUBSTRING_COMPARE_EQ (tag, 0, 6, "global");
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	271
23450 855122b993da maint: Wrap tertiary operator in parentheses "(COND ? x : y)". Rik <rik@octave.org> parents: 23220 diff changeset	272 typ = (global ? tag.substr (7) : tag);
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	273 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	274 else
20981 c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	275 typ = tag;
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	276
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	277 // Special case for backward compatibility. A small bit of cruft
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	278 if (SUBSTRING_COMPARE_EQ (typ, 0, 12, "string array"))
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	279 tc = charMatrix ();
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	280 else
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	281 tc = octave_value_typeinfo::lookup_type (typ);
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	282
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	283 if (! tc.load_ascii (is))
c11cea70b638 maint: invert if/else/error instances. John W. Eaton <jwe@octave.org> parents: 20962 diff changeset	284 error ("load: trouble reading ascii file '%s'", filename.c_str ());
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	285
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	286 return name;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	287 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	288
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	289 // Save the data from TC along with the corresponding NAME, and global
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	290 // flag MARK_AS_GLOBAL on stream OS in the plain text format described
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	291 // above for load_text_data. If NAME is empty, the name: line is not
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	292 // generated. PRECISION specifies the number of decimal digits to print.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	293 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	294 // Assumes ranges and strings cannot contain Inf or NaN values.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	295 //
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	296 // Returns 1 for success and 0 for failure.
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	297
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	298 // FIXME: should probably write the help string here too.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	299
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	300 bool
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	301 save_text_data (std::ostream& os, const octave_value& val_arg,
23470 a41fdb801db6 use mark_global and mark_persistent consistently John W. Eaton <jwe@octave.org> parents: 23450 diff changeset	302 const std::string& name, bool mark_global,
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	303 int precision)
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	304 {
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	305 bool success = true;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	306
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	307 if (! name.empty ())
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	308 os << "# name: " << name << "\n";
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	309
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	310 octave_value val = val_arg;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	311
23470 a41fdb801db6 use mark_global and mark_persistent consistently John W. Eaton <jwe@octave.org> parents: 23450 diff changeset	312 if (mark_global)
4687 e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	313 os << "# type: global " << val.type_name () << "\n";
e95c86d48732 [project @ 2004-01-06 21:53:34 by jwe] jwe parents: 4634 diff changeset	314 else
14846 460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	315 os << "# type: " << val.type_name () << "\n";
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	316
5951 b2167e370f82 [project @ 2006-08-22 05:13:42 by jwe] jwe parents: 5794 diff changeset	317 if (! precision)
b2167e370f82 [project @ 2006-08-22 05:13:42 by jwe] jwe parents: 5794 diff changeset	318 precision = Vsave_precision;
b2167e370f82 [project @ 2006-08-22 05:13:42 by jwe] jwe parents: 5794 diff changeset	319
b2167e370f82 [project @ 2006-08-22 05:13:42 by jwe] jwe parents: 5794 diff changeset	320 long old_precision = os.precision ();
b2167e370f82 [project @ 2006-08-22 05:13:42 by jwe] jwe parents: 5794 diff changeset	321 os.precision (precision);
b2167e370f82 [project @ 2006-08-22 05:13:42 by jwe] jwe parents: 5794 diff changeset	322
6974 9e32bb109980 [project @ 2007-10-08 11:06:47 by jwe] jwe parents: 6257 diff changeset	323 success = val.save_ascii (os);
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	324
10417 ad29dbbc3f70 save: make that two newline characters John W. Eaton <jwe@octave.org> parents: 10416 diff changeset	325 // Insert an extra pair of newline characters after the data so that
ad29dbbc3f70 save: make that two newline characters John W. Eaton <jwe@octave.org> parents: 10416 diff changeset	326 // multiple data elements may be handled separately by gnuplot (see
ad29dbbc3f70 save: make that two newline characters John W. Eaton <jwe@octave.org> parents: 10416 diff changeset	327 // the description of the index qualifier for the plot command in the
ad29dbbc3f70 save: make that two newline characters John W. Eaton <jwe@octave.org> parents: 10416 diff changeset	328 // gnuplot documentation).
ad29dbbc3f70 save: make that two newline characters John W. Eaton <jwe@octave.org> parents: 10416 diff changeset	329 os << "\n\n";
10416 f06ede00fd8f save: separate variables by blank line in Octave text format files John W. Eaton <jwe@octave.org> parents: 10315 diff changeset	330
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	331 os.precision (old_precision);
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	332
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	333 return (os && success);
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	334 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	335
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	336 bool
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	337 save_text_data_for_plotting (std::ostream& os, const octave_value& t,
c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	338 const std::string& name)
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	339 {
20447 c6224b4e7774 maint: Rename instances of LS_ASCII to LS_TEXT for clarity. Rik <rik@octave.org> parents: 20428 diff changeset	340 return save_text_data (os, t, name, false, 6);
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	341 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	342
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	343 // Maybe this should be a static function in tree-plot.cc?
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	344
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	345 // If TC is matrix, save it on stream OS in a format useful for
21014 b9d4c3615e89 maint: Capitalize D for dimension in messages and comments. Rik <rik@octave.org> parents: 20981 diff changeset	346 // making a 3-D plot with gnuplot. If PARAMETRIC is TRUE,
b9d4c3615e89 maint: Capitalize D for dimension in messages and comments. Rik <rik@octave.org> parents: 20981 diff changeset	347 // assume a parametric 3-D plot will be generated.
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	348
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	349 bool
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	350 save_three_d (std::ostream& os, const octave_value& tc, bool parametric)
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	351 {
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	352 bool fail = false;
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	353
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5103 diff changeset	354 octave_idx_type nr = tc.rows ();
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 5103 diff changeset	355 octave_idx_type nc = tc.columns ();
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	356
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	357 if (! tc.is_real_matrix ())
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	358 error ("for now, I can only save real matrices in 3-D format");
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	359
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	360 os << "# 3-D data...\n"
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	361 << "# type: matrix\n"
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	362 << "# total rows: " << nr << "\n"
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	363 << "# total columns: " << nc << "\n";
6171 4508e9d73ea1 [project @ 2006-11-15 20:03:18 by jwe] jwe parents: 5958 diff changeset	364
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	365 long old_precision = os.precision ();
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	366 os.precision (6);
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	367
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	368 if (parametric)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	369 {
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	370 octave_idx_type extras = nc % 3;
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	371 if (extras)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	372 warning ("ignoring last %d columns", extras);
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	373
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	374 Matrix tmp = tc.matrix_value ();
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	375 nr = tmp.rows ();
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	376
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	377 for (octave_idx_type i = 0; i < nc-extras; i += 3)
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	378 {
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	379 os << tmp.extract (0, i, nr-1, i+2);
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	380 if (i+3 < nc-extras)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	381 os << "\n";
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	382 }
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	383 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	384 else
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	385 {
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	386 Matrix tmp = tc.matrix_value ();
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	387 nr = tmp.rows ();
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	388
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	389 for (octave_idx_type i = 0; i < nc; i++)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	390 {
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	391 os << tmp.extract (0, i, nr-1, i);
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	392 if (i+1 < nc)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	393 os << "\n";
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	394 }
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	395 }
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	396
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20940 diff changeset	397 os.precision (old_precision);
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	398
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	399 return (os && ! fail);
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	400 }
79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	401
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5775 diff changeset	402 DEFUN (save_precision, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	403 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	404 @deftypefn {} {@var{val} =} save_precision ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	405 @deftypefnx {} {@var{old_val} =} save_precision (@var{new_val})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	406 @deftypefnx {} {} save_precision (@var{new_val}, "local")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	407 Query or set the internal variable that specifies the number of digits to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	408 keep when saving data in text format.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	409
23556 31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	410 The default value is 17 which is the minimum necessary for the lossless saving
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	411 and restoring of IEEE-754 double values; For IEEE-754 single values the minimum
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	412 value is 9. If file size is a concern, it is probably better to choose a
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	413 binary format for saving data rather than to reduce the precision of the saved
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	414 values.
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	415
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	416 When called from inside a function with the @qcode{"local"} option, the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	417 variable is changed locally for the function and any subroutines it calls.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	418 The original variable value is restored when exiting the function.
23556 31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	419
31b1ef1ee585 Fix Octave's -text format for saving data to make it lossless for IEEE-754 doubles. Rik <rik@octave.org> parents: 23470 diff changeset	420 @seealso{save_default_options}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	421 @end deftypefn */)
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	422 {
15215 9020dddc925a use std::numeric_limits for integer max and min values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	423 return SET_INTERNAL_VARIABLE_WITH_LIMITS (save_precision, -1,
9020dddc925a use std::numeric_limits for integer max and min values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	424 std::numeric_limits<int>::max ());
4634 79fe96966ca0 [project @ 2003-11-19 21:22:39 by jwe] jwe parents: diff changeset	425 }

Mercurial > octave

annotate libinterp/corefcn/ls-oct-text.cc @ 23556:31b1ef1ee585