src/gromacs/legacyheaders/types/matrix.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * GRoups of Organic Molecules in ACtion for Science
  34  */
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #include "simple.h"
  41
  42 typedef struct {
  43     real r, g, b;
  44 } t_rgb;
  45
  46 typedef struct {
  47     char c1; /* should all be non-zero (and printable and not '"') */
  48     char c2; /*
  49               * should all be zero (single char color names: smaller xpm's)
  50               * or should all be non-zero (double char color names: more colors)
  51               */
  52 } t_xpmelmt;
  53
  54 typedef short t_matelmt;
  55
  56 typedef struct {
  57     t_xpmelmt   code; /* see comment for t_xpmelmt */
  58     const char *desc;
  59     t_rgb       rgb;
  60 } t_mapping;
  61
  62 #define MAT_SPATIAL_X (1<<0)
  63 #define MAT_SPATIAL_Y (1<<1)
  64 /* Defines if x and y are spatial dimensions,
  65  * when not, there are n axis ticks at the middle of the elements,
  66  * when set, there are n+1 axis ticks at the edges of the elements.
  67  */
  68
  69 typedef struct {
  70     unsigned int flags; /* The possible flags are defined above */
  71     int          nx, ny;
  72     int          y0;
  73     char         title[256];
  74     char         legend[256];
  75     char         label_x[256];
  76     char         label_y[256];
  77     gmx_bool     bDiscrete;
  78     real        *axis_x;
  79     real        *axis_y;
  80     t_matelmt  **matrix;
  81     int          nmap;
  82     t_mapping   *map;
  83 } t_matrix;
  84 /* title      matrix title
  85  * legend     label for the continuous legend
  86  * label_x    label for the x-axis
  87  * label_y    label for the y-axis
  88  * nx, ny     size of the matrix
  89  * axis_x[]   the x-ticklabels
  90  * axis_y[]   the y-ticklables
  91  * *matrix[]  element x,y is matrix[x][y]
  92  * nmap       number of color levels for the output(?)
  93  */
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif