libs/dbprim/st_free.c

   1 /*
   2 ** Copyright (C) 2002 by Kevin L. Mitchell <klmitch@mit.edu>
   3 **
   4 ** This library is free software; you can redistribute it and/or
   5 ** modify it under the terms of the GNU Library General Public
   6 ** License as published by the Free Software Foundation; either
   7 ** version 2 of the License, or (at your option) any later version.
   8 **
   9 ** This library is distributed in the hope that it will be useful,
  10 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 ** Library General Public License for more details.
  13 **
  14 ** You should have received a copy of the GNU Library General Public
  15 ** License along with this library; if not, write to the Free
  16 ** Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  17 ** MA 02111-1307, USA
  18 **
  19 ** @(#)$Id$
  20 */
  21 #include "dbprim.h"
  22 #include "dbprim_int.h"
  23
  24 RCSTAG("@(#)$Id$");
  25
  26 /** \ingroup dbprim_smat
  27  * \brief Free memory used by an empty sparse matrix table.
  28  *
  29  * This function releases the memory used by the bucket table of the
  30  * empty hash table associated with a sparse matrix.
  31  *
  32  * \param table A pointer to a #smat_table_t.
  33  *
  34  * \retval DB_ERR_BADARGS       An invalid argument was given.
  35  * \retval DB_ERR_FROZEN        The table is frozen.
  36  * \retval DB_ERR_NOTEMPTY      The table is not empty.
  37  */
  38 unsigned long
  39 st_free(smat_table_t *table)
  40 {
  41   initialize_dbpr_error_table(); /* initialize error table */
  42
  43   if (!st_verify(table)) /* verify argument */
  44     return DB_ERR_BADARGS;
  45
  46   return ht_free(&table->st_table); /* call out to hash */
  47 }