/*
Copyright (C) 2003 Motorola Inc
Copyright (C) 2003 David Bateman
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with this program; see the file COPYING. If not, write to the Free
Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
In addition to the terms of the GPL, you are permitted to link
this program with any Open Source program, as defined by the
Open Source Initiative (www.opensource.org)
*/
#if defined (__GNUG__) && defined (USE_PRAGMA_INTERFACE_IMPLEMENTATION)
#pragma implementation
#endif
#include <climits>
#include <iostream>
#include <iomanip>
#include <octave/config.h>
#include <octave/oct-obj.h>
#include <octave/ov.h>
#include <octave/lo-ieee.h>
#include <octave/gripes.h>
#include <octave/unwind-prot.h>
#include <octave/cmd-edit.h>
#include <octave/utils.h>
#include <octave/variables.h>
#ifdef CLASS_HAS_LOAD_SAVE
#include <octave/ls-oct-ascii.h>
#include <octave/byte-swap.h>
#endif
#ifdef NEED_OCTAVE_QUIT
#define OCTAVE_QUIT do {} while (0)
#else
#include <octave/quit.h>
#endif
#include <memory>
#ifndef OCTAVE_LOCAL_BUFFER
#define OCTAVE_LOCAL_BUFFER(T, buf, size) \
std::auto_ptr<T> buf ## _auto_ptr (new T [size]); \
T *buf = buf ## _auto_ptr.get ()
#endif
#include "fixed-def.h"
#include "ov-base-fixed-mat.h"
#include "ov-base-fixed-mat.cc"
#include "int/fixed.h"
#include "fixed-var.h"
#include "ov-fixed.h"
#include "ov-fixed-mat.h"
#include "fixed-conv.h"
#if ! defined (UCHAR_MAX)
#define UCHAR_MAX 255
#endif
template class octave_base_fixed_matrix<FixedMatrix>;
DEFINE_OCTAVE_ALLOCATOR (octave_fixed_matrix);
#ifdef TYPEID_HAS_CLASS
DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_fixed_matrix, "fixed matrix",
"FixedPoint");
#else
DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_fixed_matrix, "fixed matrix");
#endif
#ifdef HAVE_ND_ARRAYS
NDArray
octave_fixed_matrix::array_value (bool) const
{
int nr = rows ();
int nc = columns ();
dim_vector dv(nr,nc);
NDArray retval (dv);
for (int i=0; i<nr; i++)
for (int j=0; j<nc; j++)
retval(i + j*nr) = matrix(i,j).fixedpoint();
return retval;
}
ComplexNDArray
octave_fixed_matrix::complex_array_value (bool) const
{
int nr = rows ();
int nc = columns ();
dim_vector dv(nr,nc);
ComplexNDArray retval (dv);
for (int i=0; i<nr; i++)
for (int j=0; j<nc; j++)
retval(i + j*nr) = matrix(i,j).fixedpoint();
return retval;
}
#endif
#if defined (HAVE_OCTAVE_CONCAT) || defined (HAVE_OLD_OCTAVE_CONCAT)
octave_value
octave_fixed_matrix::resize (const dim_vector& dv) const
{
if (dv.length() > 2)
{
error ("Can not resize fixed point to NDArray");
return octave_value ();
}
FixedMatrix retval (matrix);
retval.resize (dv(0), dv(1));
return new octave_fixed_matrix (retval);
}
#endif
FixedMatrix
octave_fixed_matrix::do_index_intern (const octave_value_list& idx,
int resize_ok)
{
FixedMatrix retval;
int len = idx.length ();
switch (len)
{
case 2:
{
idx_vector i = idx (0).index_vector ();
idx_vector j = idx (1).index_vector ();
retval = FixedMatrix(matrix.index (i, j, resize_ok));
}
break;
case 1:
{
idx_vector i = idx (0).index_vector ();
retval = FixedMatrix(matrix.index (i, resize_ok));
}
break;
default:
{
std::string n = type_name ();
error ("invalid number of indices (%d) for %s value",
len, n.c_str ());
}
break;
}
return retval;
}
octave_value
octave_fixed_matrix::do_index_op (const octave_value_list& idx,
int resize_ok)
{
octave_value retval;
FixedMatrix new_matrix = do_index_intern (idx, resize_ok);
if (!error_state) {
retval = new octave_fixed_matrix ( new_matrix);
retval.maybe_mutate();
}
return retval;
}
octave_value
octave_fixed_matrix::subsasgn (const std::string& type,
const std::list<octave_value_list>& idx,
const octave_value& rhs)
{
octave_value retval;
switch (type[0])
{
case '(':
{
std::string nm = type_name ();
if (type.length () == 1)
retval = numeric_assign (type, idx, rhs);
else if (type.length () == 2)
{
std::list<octave_value_list>::const_iterator p = idx.begin ();
octave_value_list key_idx = *++p;
assert (key_idx.length () == 1);
std::string key = key_idx(0).string_value ();
if (key == __FIXED_SIGN_STR)
error("can not directly change the sign in a fixed structure");
else if (key == __FIXED_VALUE_STR)
error("can not directly change the value of a fixed structure");
else if (key == __FIXED_DECSIZE_STR) {
if (rhs.is_matrix_type()) {
FixedMatrix old_matrix = do_index_intern(idx.front(), 0);
octave_value new_matrix = new octave_fixed_matrix(
old_matrix.chdecsize(rhs.matrix_value()));
retval = numeric_assign (type, idx, new_matrix);
} else {
FixedMatrix old_matrix = do_index_intern(idx.front(), 0);
octave_value new_matrix = new octave_fixed_matrix(
old_matrix.chdecsize(rhs.double_value()));
retval = numeric_assign (type, idx, new_matrix);
}
} else if (key == __FIXED_INTSIZE_STR) {
if (rhs.is_matrix_type()) {
FixedMatrix old_matrix = do_index_intern(idx.front(), 0);
octave_value new_matrix = new octave_fixed_matrix(
old_matrix.chintsize(rhs.matrix_value()));
retval = numeric_assign (type, idx, new_matrix);
} else {
FixedMatrix old_matrix = do_index_intern(idx.front(), 0);
octave_value new_matrix = new octave_fixed_matrix(
old_matrix.chintsize(rhs.double_value()));
retval = numeric_assign (type, idx, new_matrix);
}
} else
error ("fixed point structure has no member `%s'",
key.c_str ());
}
else
error ("in indexed assignment of %s, illegal assignment",
nm.c_str ());
}
break;
case '.':
{
octave_value_list key_idx = idx.front ();
assert (key_idx.length () == 1);
std::string key = key_idx(0).string_value ();
if (key == __FIXED_SIGN_STR)
error("can not directly change the sign in a fixed structure");
else if (key == __FIXED_VALUE_STR)
error("can not directly change the value of a fixed structure");
else if (key == __FIXED_DECSIZE_STR) {
if (rhs.is_matrix_type())
retval = new octave_fixed_matrix (matrix.chdecsize(
rhs.matrix_value()));
else
retval = new octave_fixed_matrix (matrix.chdecsize(
rhs.double_value()));
} else if (key == __FIXED_INTSIZE_STR) {
if (rhs.is_matrix_type())
retval = new octave_fixed_matrix (matrix.chintsize(
rhs.matrix_value()));
else
retval = new octave_fixed_matrix (matrix.chintsize(
rhs.double_value()));
} else
error ("fixed point structure has no member `%s'", key.c_str ());
}
break;
case '{':
{
std::string nm = type_name ();
error ("%s cannot be indexed with %c", nm.c_str (), type[0]);
}
break;
default:
panic_impossible ();
}
return retval;
}
octave_value *
octave_fixed_matrix::try_narrowing_conversion (void)
{
octave_value *retval = 0;
int nr = matrix.rows ();
int nc = matrix.cols ();
if (nr == 1 && nc == 1)
retval = new octave_fixed (matrix (0, 0));
return retval;
}
double
octave_fixed_matrix::double_value (bool) const
{
double retval = lo_ieee_nan_value ();
// XXX FIXME XXX -- maybe this should be a function, valid_as_scalar()
#if defined(HAVE_DO_FORTRAN_INDEXING)
if ((rows () == 1 && columns () == 1)
|| (Vdo_fortran_indexing && rows () > 0 && columns () > 0))
retval = matrix (0, 0) .fixedpoint();
#else
if (rows () > 0 && columns () > 0)
{
if (Vwarn_fortran_indexing)
gripe_implicit_conversion ("real matrix", "real scalar");
retval = matrix (0, 0) .fixedpoint();
}
#endif
else
gripe_invalid_conversion ("fixed matrix", "real scalar");
return retval;
}
Matrix
octave_fixed_matrix::matrix_value ( bool ) const
{
int nr = rows();
int nc = columns();
Matrix retval(nr, nc);
for (int i = 0; i < nr; i++)
for (int j = 0; j < nc; j++)
retval(i,j) = matrix(i,j).fixedpoint();
return retval;
}
Complex
octave_fixed_matrix::complex_value (bool) const
{
double tmp = lo_ieee_nan_value ();
Complex retval (tmp, tmp);
#if defined(HAVE_DO_FORTRAN_INDEXING)
if ((rows () == 1 && columns () == 1)
|| (Vdo_fortran_indexing && rows () > 0 && columns () > 0))
retval = matrix (0, 0) .fixedpoint();
#else
if (rows () > 0 && columns () > 0)
{
if (Vwarn_fortran_indexing)
gripe_implicit_conversion ("real matrix", "real scalar");
retval = matrix (0, 0) .fixedpoint();
}
#endif
else
gripe_invalid_conversion ("fixed matrix", "complex scalar");
return retval;
}
octave_value
octave_fixed_matrix::convert_to_str (bool) const
{
octave_value retval;
int nr = matrix.rows ();
int nc = matrix.columns ();
if (nr == 0 && nc == 0)
{
char s = '\0';
retval = octave_value (&s);
}
else
{
if (nr == 0 || nc == 0)
{
char s = '\0';
retval = octave_value (&s);
}
else
{
charMatrix chm (nr, nc);
bool warned = false;
for (int j = 0; j < nc; j++)
{
for (int i = 0; i < nr; i++)
{
OCTAVE_QUIT;
FixedPoint d = matrix (i, j);
int ival = NINT (d.fixedpoint());
if (ival < 0 || ival > UCHAR_MAX)
{
// XXX FIXME XXX -- is there something
// better we could do?
ival = 0;
if (! warned)
{
::warning ("range error for conversion to character value");
warned = true;
}
}
chm (i, j) = static_cast<char> (ival);
}
}
retval = octave_value (chm, 1);
}
}
return retval;
}
void
octave_fixed_matrix::print_raw (std::ostream& os,
bool pr_as_read_syntax) const
{
int prec = check_preference("output_precision");
double min_num = matrix.abs().row_min().min().fixedpoint();
int new_prec = (int)matrix.getdecsize().row_max().max() +
(min_num >= 1. ? (int)log10(min_num) + 1 : 0);
bind_builtin_variable ("output_precision", new_prec);
octave_print_internal (os, matrix_value(), false,
current_print_indent_level ());
bind_builtin_variable ("output_precision", prec);
}
#ifdef CLASS_HAS_LOAD_SAVE
bool
octave_fixed_matrix::save_ascii (std::ostream& os, bool& infnan_warned,
bool strip_nan_and_inf)
{
dim_vector d = dims ();
os << "# ndims: " << d.length () << "\n";
for (int i=0; i < d.length (); i++)
os << " " << d (i);
os << "\n" << matrix.getintsize () << matrix.getdecsize()
<< matrix_value();
return true;
}
bool
octave_fixed_matrix::load_ascii (std::istream& is)
{
int mdims;
bool success = true;
if (extract_keyword (is, "ndims", mdims))
{
dim_vector dv;
dv.resize (mdims);
for (int i = 0; i < mdims; i++)
is >> dv(i);
if (dv.length() != 2)
{
error ("load: N-D fixed arrays not supported");
success = false;
}
else
{
Matrix intsize (dv(0), dv(1)), decsize (dv(0), dv(1)),
number (dv(0), dv(1));
is >> intsize >> decsize >> number;
if (!is)
{
error ("load: failed to load matrix constant");
success = false;
}
matrix = FixedMatrix (intsize, decsize, number);
}
}
else
{
error ("load: failed to extract dimension of fixed point variable");
success = false;
}
return success;;
}
bool
octave_fixed_matrix::save_binary (std::ostream& os, bool& save_as_floats)
{
dim_vector d = dims ();
// Only treat 2-D array for now
if (d.length() != 2)
return false;
// Use negative value for ndims to be consistent with other types
FOUR_BYTE_INT tmp = - d.length();
os.write (X_CAST (char *, &tmp), 4);
for (int i=0; i < d.length (); i++)
{
tmp = d(i);
os.write (X_CAST (char *, &tmp), 4);
}
char size = (char) sizeof (unsigned int);
os.write (X_CAST (char *, &size), 1);
// intsize and decsize are integers in the range [0:32], so store as char
LS_DO_WRITE (char, matrix.getintsize ().fortran_vec (), 1, d.numel (), os);
LS_DO_WRITE (char, matrix.getdecsize ().fortran_vec (), 1, d.numel (), os);
LS_DO_WRITE (unsigned int, matrix.getnumber ().fortran_vec (),
sizeof (unsigned int), d.numel (), os);
return true;
}
#ifdef HAVE_SWAP_BYTES
static inline void swap_4_bytes (volatile void *ptr)
{
swap_bytes <4> (ptr);
}
#endif
bool
octave_fixed_matrix::load_binary (std::istream& is, bool swap,
oct_mach_info::float_format fmt)
{
FOUR_BYTE_INT mdims;
if (! is.read (X_CAST (char *, &mdims), 4))
return false;
if (swap)
swap_4_bytes (X_CAST (char *, &mdims));
if (mdims != -2)
return false;
mdims = - mdims;
FOUR_BYTE_INT di;
dim_vector dv;
dv.resize (mdims);
for (int i = 0; i < mdims; i++)
{
if (! is.read (X_CAST (char *, &di), 4))
return false;
if (swap)
swap_4_bytes (X_CAST (char *, &di));
dv(i) = di;
}
char size;
Matrix intsize (dv(0), dv(1)), decsize (dv(0), dv(1)),
number(dv(0), dv(1));
if (! is.read (X_CAST (char *, &size), 1))
return false;
LS_DO_READ_1(intsize.fortran_vec (), dv.numel (), is);
LS_DO_READ_1(decsize.fortran_vec (), dv.numel (), is);
if (size == 4)
LS_DO_READ(unsigned int, swap, number.fortran_vec (), 4,
dv.numel (), is);
else if (size == 8)
LS_DO_READ(unsigned int, swap, number.fortran_vec (), 8,
dv.numel (), is);
else
return false;
if (error_state || ! is)
return false;
// This is ugly, is there a better way?
matrix.resize (dv(0), dv(1));
for (int i = 0; i < dv(0); i++)
for (int j = 0; j < dv(1); j++)
matrix (i, j) = FixedPoint ((unsigned int)intsize (i, j),
(unsigned int)decsize (i, j),
(unsigned int)number (i, j));
return true;
}
#if defined (HAVE_HDF5)
bool
octave_fixed_matrix::save_hdf5 (hid_t loc_id, const char *name, bool save_as_floats)
{
hid_t group_hid = -1;
group_hid = H5Gcreate (loc_id, name, 0);
if (group_hid < 0 ) return false;
dim_vector d = dims ();
hsize_t hdims[d.length () > 2 ? d.length () : 3];
hid_t space_hid = -1, data_hid = -1;
int rank = ( (d (0) == 1) && (d.length () == 2) ? 1 : d.length ());
bool retval = true;
// Octave uses column-major, while HDF5 uses row-major ordering
for (int i = 0, j = d.length() - 1; i < d.length (); i++, j--)
hdims[i] = d (j);
space_hid = H5Screate_simple (rank, hdims, (hsize_t*) 0);
if (space_hid < 0)
{
H5Gclose (group_hid);
return false;
}
data_hid = H5Dcreate (group_hid, "int", H5T_NATIVE_UCHAR, space_hid,
H5P_DEFAULT);
if (data_hid < 0)
{
H5Sclose (space_hid);
H5Gclose (group_hid);
return false;
}
double * m = matrix.getintsize ().fortran_vec ();
OCTAVE_LOCAL_BUFFER(unsigned char, tmp, d.numel ());
for (int i = 0; i < d.numel (); i++)
tmp[i] = (unsigned char) m[i];
retval = H5Dwrite (data_hid, H5T_NATIVE_UCHAR, H5S_ALL, H5S_ALL, H5P_DEFAULT,
(void*) tmp) >= 0;
H5Dclose (data_hid);
if (!retval)
{
H5Sclose (space_hid);
H5Gclose (group_hid);
return false;
}
data_hid = H5Dcreate (group_hid, "dec", H5T_NATIVE_UCHAR, space_hid,
H5P_DEFAULT);
if (data_hid < 0)
{
H5Sclose (space_hid);
H5Gclose (group_hid);
return false;
}
m = matrix.getdecsize ().fortran_vec ();
for (int i = 0; i < d.numel (); i++)
tmp[i] = (unsigned char) m[i];
retval = H5Dwrite (data_hid, H5T_NATIVE_UCHAR, H5S_ALL, H5S_ALL, H5P_DEFAULT,
(void*) tmp) >= 0;
H5Dclose (data_hid);
if (!retval)
{
H5Sclose (space_hid);
H5Gclose (group_hid);
return false;
}
data_hid = H5Dcreate (group_hid, "num", H5T_NATIVE_UINT, space_hid,
H5P_DEFAULT);
if (data_hid < 0)
{
H5Sclose (space_hid);
H5Gclose (group_hid);
return false;
}
m = matrix.getnumber ().fortran_vec ();
OCTAVE_LOCAL_BUFFER(unsigned int, num, d.numel ());
for (int i = 0; i < d.numel (); i++)
num[i] = (unsigned int) m[i];
retval = H5Dwrite (data_hid, H5T_NATIVE_UINT, H5S_ALL, H5S_ALL, H5P_DEFAULT,
(void*) num) >= 0;
H5Dclose (data_hid);
H5Sclose (space_hid);
H5Gclose (group_hid);
return retval;
}
bool
octave_fixed_matrix::load_hdf5 (hid_t loc_id, const char *name,
bool have_h5giterate_bug)
{
herr_t retval = -1;
hid_t group_hid, data_hid, space_id;
hsize_t rank, rank_old;
group_hid = H5Gopen (loc_id, name);
if (group_hid < 0 ) return false;
data_hid = H5Dopen (group_hid, "int");
space_id = H5Dget_space (data_hid);
rank = H5Sget_simple_extent_ndims (space_id);
rank_old = rank;
if (rank < 1 || rank > 2)
{
// No N-D array yet
H5Sclose (space_id);
H5Dclose (data_hid);
H5Gclose (group_hid);
return false;
}
OCTAVE_LOCAL_BUFFER (hsize_t, hdims, rank);
OCTAVE_LOCAL_BUFFER (hsize_t, maxdims, rank);
H5Sget_simple_extent_dims (space_id, hdims, maxdims);
dim_vector dv;
dim_vector dv_old;
// Octave uses column-major, while HDF5 uses row-major ordering
if (rank == 1)
{
dv.resize (2);
dv(0) = 1;
dv(1) = hdims[0];
}
else
{
dv.resize (rank);
for (int i = 0, j = rank - 1; i < (int)rank; i++, j--)
dv(j) = hdims[i];
}
dv_old = dv;
OCTAVE_LOCAL_BUFFER (unsigned int, intsize, dv.numel ());
if (H5Dread (data_hid, H5T_NATIVE_INT, H5S_ALL, H5S_ALL,
H5P_DEFAULT, (void *) intsize) < 0)
{
H5Sclose (space_id);
H5Dclose (data_hid);
H5Gclose (group_hid);
return false;
}
H5Dclose (data_hid);
data_hid = H5Dopen (group_hid, "dec");
space_id = H5Dget_space (data_hid);
rank = H5Sget_simple_extent_ndims (space_id);
if (rank != rank_old)
{
H5Sclose (space_id);
H5Dclose (data_hid);
H5Gclose (group_hid);
return false;
}
H5Sget_simple_extent_dims (space_id, hdims, maxdims);
// Octave uses column-major, while HDF5 uses row-major ordering
if (rank == 1)
{
dv.resize (2);
dv(0) = 1;
dv(1) = hdims[0];
}
else
{
dv.resize (rank);
for (int i = 0, j = rank - 1; i < (int)rank; i++, j--)
dv(j) = hdims[i];
}
if (dv_old != dv)
{
H5Sclose (space_id);
H5Dclose (data_hid);
H5Gclose (group_hid);
return false;
}
OCTAVE_LOCAL_BUFFER (unsigned int, decsize, dv.numel ());
if (H5Dread (data_hid, H5T_NATIVE_INT, H5S_ALL, H5S_ALL,
H5P_DEFAULT, (void *) decsize) < 0)
{
H5Sclose (space_id);
H5Dclose (data_hid);
H5Gclose (group_hid);
return false;
}
H5Dclose (data_hid);
data_hid = H5Dopen (group_hid, "num");
space_id = H5Dget_space (data_hid);
rank = H5Sget_simple_extent_ndims (space_id);
if (rank != rank_old)
{
H5Sclose (space_id);
H5Dclose (data_hid);
H5Gclose (group_hid);
return false;
}
H5Sget_simple_extent_dims (space_id, hdims, maxdims);
// Octave uses column-major, while HDF5 uses row-major ordering
if (rank == 1)
{
dv.resize (2);
dv(0) = 1;
dv(1) = hdims[0];
}
else
{
dv.resize (rank);
for (int i = 0, j = rank - 1; i < (int)rank; i++, j--)
dv(j) = hdims[i];
}
if (dv_old != dv)
{
H5Sclose (space_id);
H5Dclose (data_hid);
H5Gclose (group_hid);
return false;
}
OCTAVE_LOCAL_BUFFER (unsigned int, number, dv.numel ());
retval = H5Dread (data_hid, H5T_NATIVE_INT, H5S_ALL, H5S_ALL,
H5P_DEFAULT, (void *) number);
H5Dclose (data_hid);
H5Sclose (space_id);
H5Gclose (group_hid);
if (retval < 0)
return false;
// This is ugly, is there a better way?
matrix.resize (dv(0), dv(1));
unsigned int * ivec = intsize;
unsigned int * dvec = decsize;
unsigned int * nvec = number;
for (int j = 0; j < dv(1); j++)
for (int i = 0; i < dv(0); i++)
matrix (i, j) = FixedPoint (*ivec++, *dvec++, *nvec++);
return true;
}
#endif
#endif
/*
;;; Local Variables: ***
;;; mode: C++ ***
;;; End: ***
*/
syntax highlighted by Code2HTML, v. 0.9.1