/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ /* This file is part of the program and library */ /* SCIP --- Solving Constraint Integer Programs */ /* */ /* Copyright 2002-2022 Zuse Institute Berlin */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); */ /* you may not use this file except in compliance with the License. */ /* You may obtain a copy of the License at */ /* */ /* http://www.apache.org/licenses/LICENSE-2.0 */ /* */ /* Unless required by applicable law or agreed to in writing, software */ /* distributed under the License is distributed on an "AS IS" BASIS, */ /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ /* See the License for the specific language governing permissions and */ /* limitations under the License. */ /* */ /* You should have received a copy of the Apache-2.0 license */ /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /**@file scip_datastructures.h * @ingroup PUBLICCOREAPI * @brief public methods for data structures * @author Tobias Achterberg * @author Timo Berthold * @author Thorsten Koch * @author Alexander Martin * @author Marc Pfetsch * @author Kati Wolter * @author Gregor Hendel * @author Leona Gottwald */ /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ #ifndef __SCIP_SCIP_DATASTRUCTURES_H__ #define __SCIP_SCIP_DATASTRUCTURES_H__ #include "scip/def.h" #include "scip/type_misc.h" #include "scip/type_retcode.h" #include "scip/type_scip.h" #ifdef __cplusplus extern "C" { #endif /**@addtogroup PublicDynamicArrayMethods * * @{ */ /** creates a dynamic array of real values * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPcreateRealarray( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY** realarray /**< pointer to store the real array */ ); /** frees a dynamic array of real values * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPfreeRealarray( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY** realarray /**< pointer to the real array */ ); /** extends dynamic array to be able to store indices from minidx to maxidx * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPextendRealarray( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY* realarray, /**< dynamic real array */ int minidx, /**< smallest index to allocate storage for */ int maxidx /**< largest index to allocate storage for */ ); /** clears a dynamic real array * * @return clears a dynamic real array */ SCIP_EXPORT SCIP_RETCODE SCIPclearRealarray( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY* realarray /**< dynamic real array */ ); /** gets value of entry in dynamic array */ SCIP_EXPORT SCIP_Real SCIPgetRealarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY* realarray, /**< dynamic real array */ int idx /**< array index to get value for */ ); /** sets value of entry in dynamic array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPsetRealarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY* realarray, /**< dynamic real array */ int idx, /**< array index to set value for */ SCIP_Real val /**< value to set array index to */ ); /** increases value of entry in dynamic array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPincRealarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY* realarray, /**< dynamic real array */ int idx, /**< array index to increase value for */ SCIP_Real incval /**< value to increase array index */ ); /** returns the minimal index of all stored non-zero elements * * @return the minimal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetRealarrayMinIdx( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY* realarray /**< dynamic real array */ ); /** returns the maximal index of all stored non-zero elements * * @return the maximal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetRealarrayMaxIdx( SCIP* scip, /**< SCIP data structure */ SCIP_REALARRAY* realarray /**< dynamic real array */ ); /** creates a dynamic array of int values * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPcreateIntarray( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY** intarray /**< pointer to store the int array */ ); /** frees a dynamic array of int values * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPfreeIntarray( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY** intarray /**< pointer to the int array */ ); /** extends dynamic array to be able to store indices from minidx to maxidx * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPextendIntarray( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY* intarray, /**< dynamic int array */ int minidx, /**< smallest index to allocate storage for */ int maxidx /**< largest index to allocate storage for */ ); /** clears a dynamic int array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPclearIntarray( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY* intarray /**< dynamic int array */ ); /** gets value of entry in dynamic array * * @return value of entry in dynamic array */ SCIP_EXPORT int SCIPgetIntarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY* intarray, /**< dynamic int array */ int idx /**< array index to get value for */ ); /** sets value of entry in dynamic array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPsetIntarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY* intarray, /**< dynamic int array */ int idx, /**< array index to set value for */ int val /**< value to set array index to */ ); /** increases value of entry in dynamic array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPincIntarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY* intarray, /**< dynamic int array */ int idx, /**< array index to increase value for */ int incval /**< value to increase array index */ ); /** returns the minimal index of all stored non-zero elements * * @return the minimal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetIntarrayMinIdx( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY* intarray /**< dynamic int array */ ); /** returns the maximal index of all stored non-zero elements * * @return the maximal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetIntarrayMaxIdx( SCIP* scip, /**< SCIP data structure */ SCIP_INTARRAY* intarray /**< dynamic int array */ ); /** creates a dynamic array of bool values * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPcreateBoolarray( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY** boolarray /**< pointer to store the bool array */ ); /** frees a dynamic array of bool values * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPfreeBoolarray( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY** boolarray /**< pointer to the bool array */ ); /** extends dynamic array to be able to store indices from minidx to maxidx * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPextendBoolarray( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY* boolarray, /**< dynamic bool array */ int minidx, /**< smallest index to allocate storage for */ int maxidx /**< largest index to allocate storage for */ ); /** clears a dynamic bool array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPclearBoolarray( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY* boolarray /**< dynamic bool array */ ); /** gets value of entry in dynamic array * * @return value of entry in dynamic array at position idx */ SCIP_EXPORT SCIP_Bool SCIPgetBoolarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY* boolarray, /**< dynamic bool array */ int idx /**< array index to get value for */ ); /** sets value of entry in dynamic array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPsetBoolarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY* boolarray, /**< dynamic bool array */ int idx, /**< array index to set value for */ SCIP_Bool val /**< value to set array index to */ ); /** returns the minimal index of all stored non-zero elements * * @return the minimal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetBoolarrayMinIdx( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY* boolarray /**< dynamic bool array */ ); /** returns the maximal index of all stored non-zero elements * * @return the maximal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetBoolarrayMaxIdx( SCIP* scip, /**< SCIP data structure */ SCIP_BOOLARRAY* boolarray /**< dynamic bool array */ ); /** creates a dynamic array of pointers * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPcreatePtrarray( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY** ptrarray /**< pointer to store the int array */ ); /** frees a dynamic array of pointers * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPfreePtrarray( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY** ptrarray /**< pointer to the int array */ ); /** extends dynamic array to be able to store indices from minidx to maxidx * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPextendPtrarray( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY* ptrarray, /**< dynamic int array */ int minidx, /**< smallest index to allocate storage for */ int maxidx /**< largest index to allocate storage for */ ); /** clears a dynamic pointer array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPclearPtrarray( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY* ptrarray /**< dynamic int array */ ); /** gets value of entry in dynamic array */ SCIP_EXPORT void* SCIPgetPtrarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY* ptrarray, /**< dynamic int array */ int idx /**< array index to get value for */ ); /** sets value of entry in dynamic array * * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes. */ SCIP_EXPORT SCIP_RETCODE SCIPsetPtrarrayVal( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY* ptrarray, /**< dynamic int array */ int idx, /**< array index to set value for */ void* val /**< value to set array index to */ ); /** returns the minimal index of all stored non-zero elements * * @return the minimal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetPtrarrayMinIdx( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY* ptrarray /**< dynamic ptr array */ ); /** returns the maximal index of all stored non-zero elements * * @return the maximal index of all stored non-zero elements */ SCIP_EXPORT int SCIPgetPtrarrayMaxIdx( SCIP* scip, /**< SCIP data structure */ SCIP_PTRARRAY* ptrarray /**< dynamic ptr array */ ); /**@} */ /**@addtogroup DisjointSet * * @{ */ /** creates a disjoint set (union find) structure \p djset for \p ncomponents many components (of size one) */ SCIP_EXPORT SCIP_RETCODE SCIPcreateDisjointset( SCIP* scip, /**< SCIP data structure */ SCIP_DISJOINTSET** djset, /**< disjoint set (union find) data structure */ int ncomponents /**< number of components */ ); /** frees the disjoint set (union find) data structure */ SCIP_EXPORT void SCIPfreeDisjointset( SCIP* scip, /**< SCIP data structure */ SCIP_DISJOINTSET** djset /**< pointer to disjoint set (union find) data structure */ ); /** @} */ /**@addtogroup DirectedGraph * * @{ */ /** creates directed graph structure */ SCIP_EXPORT SCIP_RETCODE SCIPcreateDigraph( SCIP* scip, /**< SCIP data structure */ SCIP_DIGRAPH** digraph, /**< pointer to store the created directed graph */ int nnodes /**< number of nodes */ ); /**! [SnippetCodeStyleComment] */ /** copies directed graph structure * * The copying procedure uses the memory of the passed SCIP instance. The user must ensure that the digraph lives * as most as long as the SCIP instance. * * @note The data in nodedata is copied verbatim. This possibly has to be adapted by the user. */ SCIP_EXPORT SCIP_RETCODE SCIPcopyDigraph( SCIP* scip, /**< SCIP data structure */ SCIP_DIGRAPH** targetdigraph, /**< pointer to store the copied directed graph */ SCIP_DIGRAPH* sourcedigraph /**< source directed graph */ ); /**! [SnippetCodeStyleComment] */ /**@} */ #ifdef __cplusplus } #endif #endif