View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2023.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.potential.openmm;
39  
40  import com.sun.jna.ptr.PointerByReference;
41  
42  import static edu.uiowa.jopenmm.OpenMMLibrary.OpenMM_IntArray_append;
43  import static edu.uiowa.jopenmm.OpenMMLibrary.OpenMM_IntArray_create;
44  import static edu.uiowa.jopenmm.OpenMMLibrary.OpenMM_IntArray_destroy;
45  import static edu.uiowa.jopenmm.OpenMMLibrary.OpenMM_IntArray_resize;
46  import static edu.uiowa.jopenmm.OpenMMLibrary.OpenMM_IntArray_set;
47  
48  /**
49   * OpenMM IntArray wrapper.
50   */
51  public class OpenMMIntArray {
52  
53    private final PointerByReference intArrayPointer;
54  
55    /**
56     * Constructor.
57     *
58     * @param size The size of the array.
59     */
60    public OpenMMIntArray(int size) {
61      intArrayPointer = OpenMM_IntArray_create(size);
62    }
63  
64    /**
65     * Append a int value to the array.
66     *
67     * @param value The value to append.
68     */
69    public void append(int value) {
70      OpenMM_IntArray_append(intArrayPointer, value);
71    }
72  
73    /**
74     * Set a value in the array.
75     *
76     * @param index The index.
77     * @param value The value.
78     */
79    public void set(int index, int value) {
80      OpenMM_IntArray_set(intArrayPointer, index, value);
81    }
82  
83    /**
84     * Destroy the array.
85     */
86    public void destroy() {
87      OpenMM_IntArray_destroy(intArrayPointer);
88    }
89  
90    /**
91     * Resize the array.
92     *
93     * @param size The new size.
94     */
95    public void resize(int size) {
96      OpenMM_IntArray_resize(intArrayPointer, size);
97    }
98  
99    /**
100    * Get the pointer to the array.
101    *
102    * @return The pointer.
103    */
104   public PointerByReference getPointer() {
105     return intArrayPointer;
106   }
107 
108 }