2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2009,2010,2011, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Declares ::gmx_ana_selvalue_t.
39 * There should be no need to use the data structures in this file directly
40 * unless implementing a custom selection routine.
42 * \author Teemu Murtola <teemu.murtola@gmail.com>
43 * \ingroup module_selection
45 #ifndef GMX_SELECTION_SELVALUE_H
46 #define GMX_SELECTION_SELVALUE_H
48 #include "../legacyheaders/types/simple.h"
50 /** Defines the value type of a different selection objects. */
53 NO_VALUE, /**< No value; either an error condition or an boolean
55 INT_VALUE, /**< One or more integer values. */
56 REAL_VALUE, /**< One or more real values. */
57 STR_VALUE, /**< One or more string values. */
58 POS_VALUE, /**< One or more position values. */
59 GROUP_VALUE /**< One group of atoms. */
63 * Describes a value of a selection expression or of a selection method
66 * Which field in the union is used depends on the \p type.
68 typedef struct gmx_ana_selvalue_t
70 /** Type of the value. */
73 * Number of values in the array pointed by the union.
75 * Note that for position and group values, it is the number of
76 * data structures in the array, not the number of positions or
77 * the number of atoms in the group.
80 /** Pointer to the value. */
83 * Generic pointer for operations that do not need type information.
85 * Needs to be the first member to be able to use initialized arrays.
88 /** Integer value(s) (type \ref INT_VALUE). */
90 /** Real value(s) (type \ref REAL_VALUE). */
92 /** String value(s) (type \ref STR_VALUE). */
94 /** Structure for the position value(s) (type \ref POS_VALUE). */
95 struct gmx_ana_pos_t *p;
96 /** Group value (type \ref GROUP_VALUE). */
97 struct gmx_ana_index_t *g;
98 /** Boolean value (only parameters of type \ref NO_VALUE); */
102 * Number of elements allocated for the value array.
105 } gmx_ana_selvalue_t;
107 /** Initializes an empty selection value structure. */
109 _gmx_selvalue_clear(gmx_ana_selvalue_t *val);
110 /** Reserve memory for storing selection values. */
112 _gmx_selvalue_reserve(gmx_ana_selvalue_t *val, int n);
113 /** Sets the memory for storing selection values. */
115 _gmx_selvalue_setstore(gmx_ana_selvalue_t *val, void *ptr);
116 /** Sets the memory for storing selection values and marks it for automatic freeing. */
118 _gmx_selvalue_setstore_alloc(gmx_ana_selvalue_t *val, void *ptr, int nalloc);