hsl_ma77s.h

Go to the documentation of this file.

/*
 * COPYRIGHT (c) 2011 Science and Technology Facilities Council (STFC)
 * Original date 18 May 2011
 * All rights reserved
 *
 * Written by: Jonathan Hogg
 *
 * THIS FILE ONLY may be redistributed under the below modified BSD licence.
 * All other files distributed as part of the HSL_MA77 package
 * require a licence to be obtained from STFC and may NOT be redistributed
 * without permission. Please refer to your licence for HSL_MA77 for full terms
 * and conditions. STFC may be contacted via hsl(at)stfc.ac.uk.
 *
 * Modified BSD licence (this header file only):
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *  * Neither the name of STFC nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL STFC BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
 
#ifndef HSL_MA77S_H
#define HSL_MA77S_H
 
#ifndef ma77_default_control
#define ma77_control ma77_control_s
#define ma77_info ma77_info_s
#define ma77_default_control ma77_default_control_s
#define ma77_open_nelt ma77_open_nelt_s
#define ma77_open ma77_open_s
#define ma77_input_vars ma77_input_vars_s
#define ma77_input_reals ma77_input_reals_s
#define ma77_analyse ma77_analyse_s
#define ma77_factor ma77_factor_s
#define ma77_factor_solve ma77_factor_solve_s
#define ma77_solve ma77_solve_s
#define ma77_resid ma77_resid_s
#define ma77_scale ma77_scale_s
#define ma77_enquire_posdef ma77_enquire_posdef_s
#define ma77_enquire_indef ma77_enquire_indef_s
#define ma77_alter ma77_alter_s
#define ma77_restart ma77_restart_s
#define ma77_finalise ma77_finalise_s
#define ma77_solve_fredholm ma77_solve_fredholm_s
#define ma77_lmultiply ma77_lmultiply_s
#endif
 
typedef float ma77pkgtype_s_;
 
/* Data type for user controls */
struct ma77_control_s {
   /* Note: 0 is false, non-zero is true */
 
   /* C/Fortran interface related controls */
   int f_arrays; /* Treat arrays as 1-based (Fortran) if true or 0-based (C) if
                    false. */
 
   /* Printing controls */
   int print_level;
   int unit_diagnostics;   /* unit for diagnostic messages
                              Printing is suppressed if unit_diagnostics < 0. */
   int unit_error;         /* unit for error messages
                              Printing is suppressed if unit_error  <  0.     */
   int unit_warning;       /* unit for warning messages
                              Printing is suppressed if unit_warning  <  0.   */
 
   /* Controls used by MA77_open */
   int bits;
   int buffer_lpage[2];
   int buffer_npage[2];
   long int file_size;
   long int maxstore;
   long int storage[3];
 
   /* Controls used by MA77_analyse */
   int nemin;  /* Node amalgamation parameter. A child node is merged with its
                  parent if they both involve fewer than nemin eliminations.*/
 
   /* Controls used by MA77_scale */
   int maxit;
   int infnorm;
   ma77pkgtype_s_ thresh;
 
   /* Controls used by MA77_factor with posdef true */
   int nb54;
 
   /* Controls used by MA77_factor with posdef false */
   int action;    /* Keep going even if matrix is singular if true, or abort
                     if false */
   ma77pkgtype_s_ multiplier;
   int nb64;
   int nbi;
   ma77pkgtype_s_ small;
   ma77pkgtype_s_ static_;
   long int storage_indef;
   ma77pkgtype_s_ u;       /* Pivot tolerance*/
   ma77pkgtype_s_ umin;    /* Minimum pivot tolerance*/
 
   /* Controls used by ma77_solve_fredholm */
   ma77pkgtype_s_ consist_tol;   /* Tolerance for consistent singular system */
 
   /* Pad data structure to allow for future growth */
   int ispare[5]; long int lspare[5]; ma77pkgtype_s_ rspare[5];
};
 
/***************************************************/
 
/* data type for returning information to user.*/
struct ma77_info_s {
   ma77pkgtype_s_ detlog;
   int detsign;
   int flag;
   int iostat;
   int matrix_dup;
   int matrix_rank;
   int matrix_outrange;
   int maxdepth;
   int maxfront;
   long int minstore;
   int ndelay;
   long int nfactor;
   long int nflops;
   int niter;
   int nsup;
   int num_neg;
   int num_nothresh;
   int num_perturbed;
   int ntwo;
   int stat;
   int index[4];
   long int nio_read[2];
   long int nio_write[2];
   long int nwd_read[2];
   long int nwd_write[2];
   int num_file[4];
   long int storage[4];
   int tree_nodes;
   int unit_restart;
   int unused;
   ma77pkgtype_s_ usmall;
 
   /* Pad data structure to allow for future growth */
   int ispare[5]; long int lspare[5]; ma77pkgtype_s_ rspare[5];
};
 
/* Initialise control with default values */
void ma77_default_control_s(struct ma77_control_s *control);
void ma77_open_nelt_s(const int n, const char* fname1, const char* fname2,
   const char *fname3, const char *fname4, void **keep,
   const struct ma77_control_s *control, struct ma77_info_s *info,
   const int nelt);
void ma77_open_s(const int n, const char* fname1, const char* fname2,
   const char *fname3, const char *fname4, void **keep,
   const struct ma77_control_s *control, struct ma77_info_s *info);
void ma77_input_vars_s(const int idx, const int nvar, const int list[],
   void **keep, const struct ma77_control_s *control, struct ma77_info_s *info);
void ma77_input_reals_s(const int idx, const int length,
   const ma77pkgtype_s_ reals[], void **keep,
   const struct ma77_control_s *control, struct ma77_info_s *info);
/* Analyse the sparsity pattern and prepare for factorization */
void ma77_analyse_s(const int order[], void **keep,
   const struct ma77_control_s *control, struct ma77_info_s *info);
/* To factorize the matrix */
void ma77_factor_s(const int posdef, void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info,
   const ma77pkgtype_s_ *scale);
/* To factorize the matrix AND solve AX = B */
void ma77_factor_solve_s(const int posdef, void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info,
   const ma77pkgtype_s_ *scale, const int nrhs, const int lx,
   ma77pkgtype_s_ rhs[]);
/* To solve AX = B using the computed factors */
void ma77_solve_s(const int job, const int nrhs, const int lx, ma77pkgtype_s_ x[],
   void **keep, const struct ma77_control_s *control, struct ma77_info_s *info,
   const ma77pkgtype_s_ *scale);
void ma77_resid_s(const int nrhs, const int lx, const ma77pkgtype_s_ x[],
   const int lresid, ma77pkgtype_s_ resid[], void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info,
   ma77pkgtype_s_ *anorm_bnd);
void ma77_scale_s(ma77pkgtype_s_ scale[], void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info,
   ma77pkgtype_s_ *anorm);
void ma77_enquire_posdef_s(ma77pkgtype_s_ d[], void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info);
void ma77_enquire_indef_s(int piv_order[], ma77pkgtype_s_ d[], void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info);
void ma77_alter_s(const ma77pkgtype_s_ d[], void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info);
void ma77_restart_s(const char *restart_file, const char *fname1, 
   const char *fname2, const char *fname3, const char *fname4, void **keep, 
   const struct ma77_control_s *control, struct ma77_info_s *info);
void ma77_solve_fredholm_s(int nrhs, int flag_out[], int lx, ma77pkgtype_s_ x[],
   void **keep, const struct ma77_control_s *control,
   struct ma77_info_s *info, const ma77pkgtype_s_ *scale);
void ma77_lmultiply_s(int trans, int k, int lx, ma77pkgtype_s_ x[], int ly,
   ma77pkgtype_s_ y[], void **keep, const struct ma77_control_s *control,
   struct ma77_info_s *info, const ma77pkgtype_s_ *scale);
/* To clean up memory in keep */
void ma77_finalise_s(void **keep, const struct ma77_control_s *control,
   struct ma77_info_s *info);
 
#endif