libs/dbprim/sh_init.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 Dynamically initialize a sparse matrix row or column head.
  28  *
  29  * This function dynamically initializes a sparse matrix row or column
  30  * linked list head.  The \p elem argument specifies whether the
  31  * object is to be associated with a #SMAT_LOC_FIRST list or a
  32  * #SMAT_LOC_SECOND list.
  33  *
  34  * \param head  A pointer to a #smat_head_t to be initialized.
  35  * \param elem  Either #SMAT_LOC_FIRST or #SMAT_LOC_SECOND.
  36  * \param object
  37  *              A pointer to the object containing the sparse matrix
  38  *              row or column head.
  39  *
  40  * \retval DB_ERR_BADARGS       An invalid argument was given.
  41  */
  42 unsigned long
  43 sh_init(smat_head_t *head, smat_loc_t elem, void *object)
  44 {
  45   unsigned long retval;
  46
  47   initialize_dbpr_error_table(); /* initialize error table */
  48
  49   /* verify arguments... */
  50   if (!head || (elem != SMAT_LOC_FIRST && elem != SMAT_LOC_SECOND))
  51     return DB_ERR_BADARGS;
  52
  53   /* initialize list head */
  54   if ((retval = ll_init(&head->sh_head, object)))
  55     return retval;
  56
  57   head->sh_elem = elem; /* initialize list head */
  58   head->sh_table = 0;
  59
  60   head->sh_magic = SMAT_HEAD_MAGIC; /* set magic number */
  61
  62   return 0;
  63 }