sc_statistics.h

Go to the documentation of this file.

/*
  This file is part of the SC Library.
  The SC Library provides support for parallel scientific applications.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
 
  The SC Library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  The SC Library 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
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with the SC Library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/
 
#ifndef SC_STATISTICS_H
#define SC_STATISTICS_H
 
#include <sc_keyvalue.h>
 
SC_EXTERN_C_BEGIN;
 
extern const int    sc_stats_group_all;
 
extern const int    sc_stats_prio_all;
 
typedef struct sc_statinfo
{
  int                 dirty;            
  long                count;            
  double              sum_values;       
  double              sum_squares;      
  double              min;              
  double              max;              
  int                 min_at_rank, max_at_rank; /* out */
  double              average, variance, standev;       /* out */
  double              variance_mean, standev_mean;      /* out */
  const char         *variable;         
  char               *variable_owned;   
  int                 group;            
  int                 prio;             
}
sc_statinfo_t;
 
typedef struct sc_stats
{
  sc_MPI_Comm         mpicomm;
  sc_keyvalue_t      *kv;
  sc_array_t         *sarray;
}
sc_statistics_t;
 
void                sc_stats_set1 (sc_statinfo_t * stats,
                                   double value, const char *variable);
 
void                sc_stats_set1_ext (sc_statinfo_t * stats,
                                       double value, const char *variable,
                                       int copy_variable,
                                       int stats_group, int stats_prio);
 
void                sc_stats_init (sc_statinfo_t * stats,
                                   const char *variable);
 
void                sc_stats_init_ext (sc_statinfo_t * stats,
                                       const char *variable,
                                       int copy_variable,
                                       int stats_group, int stats_prio);
 
void                sc_stats_reset (sc_statinfo_t * stats, int reset_vgp);
 
void                sc_stats_set_group_prio (sc_statinfo_t * stats,
                                             int stats_group, int stats_prio);
 
void                sc_stats_accumulate (sc_statinfo_t * stats, double value);
 
void                sc_stats_compute (sc_MPI_Comm mpicomm, int nvars,
                                      sc_statinfo_t * stats);
 
void                sc_stats_compute1 (sc_MPI_Comm mpicomm, int nvars,
                                       sc_statinfo_t * stats);
 
void                sc_stats_print (int package_id, int log_priority,
                                    int nvars, sc_statinfo_t * stats,
                                    int full, int summary);
 
void                sc_stats_print_ext (int package_id, int log_priority,
                                        int nvars, sc_statinfo_t * stats,
                                        int stats_group, int stats_prio,
                                        int full, int summary);
 
sc_statistics_t    *sc_statistics_new (sc_MPI_Comm mpicomm);
 
void                sc_statistics_destroy (sc_statistics_t * stats);
 
void                sc_statistics_add (sc_statistics_t * stats,
                                       const char *name);
 
void                sc_statistics_add_empty (sc_statistics_t * stats,
                                             const char *name);
 
int                 sc_statistics_has (sc_statistics_t * stats,
                                       const char *name);
void                sc_statistics_set (sc_statistics_t * stats,
                                       const char *name, double value);
 
void                sc_statistics_accumulate (sc_statistics_t * stats,
                                              const char *name, double value);
 
void                sc_statistics_compute (sc_statistics_t * stats);
 
void                sc_statistics_print (sc_statistics_t * stats,
                                         int package_id, int log_priority,
                                         int full, int summary);
 
SC_EXTERN_C_END;
 
#endif /* !SC_STATISTICS_H */