Scippy

SCIP

Solving Constraint Integer Programs

expr_product.h
Go to the documentation of this file.
1/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2/* */
3/* This file is part of the program and library */
4/* SCIP --- Solving Constraint Integer Programs */
5/* */
6/* Copyright (c) 2002-2024 Zuse Institute Berlin (ZIB) */
7/* */
8/* Licensed under the Apache License, Version 2.0 (the "License"); */
9/* you may not use this file except in compliance with the License. */
10/* You may obtain a copy of the License at */
11/* */
12/* http://www.apache.org/licenses/LICENSE-2.0 */
13/* */
14/* Unless required by applicable law or agreed to in writing, software */
15/* distributed under the License is distributed on an "AS IS" BASIS, */
16/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17/* See the License for the specific language governing permissions and */
18/* limitations under the License. */
19/* */
20/* You should have received a copy of the Apache-2.0 license */
21/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22/* */
23/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24
25/**@file expr_product.h
26 * @ingroup EXPRHDLRS
27 * @brief product expression handler
28 * @author Stefan Vigerske
29 * @author Benjamin Mueller
30 */
31
32/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
33
34#ifndef __SCIP_EXPR_PROD_H__
35#define __SCIP_EXPR_PROD_H__
36
37
38#include "scip/scip.h"
39#include "scip/type_expr.h"
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45/** creates the handler for product expressions and includes it into SCIP
46 *
47 * @ingroup ExprhdlrIncludes
48 */
49SCIP_EXPORT
51 SCIP* scip /**< SCIP data structure */
52 );
53
54/**@addtogroup EXPRHDLRS
55 *
56 * @{
57 *
58 * @name Product expression
59 *
60 * This expression handler provides the product function, that is,
61 * \f[
62 * x \mapsto c\,\prod_{i=1}^n x_i
63 * \f]
64 * for some constant coefficient c.
65 * @{
66 */
67
68/** creates a product expression */
69SCIP_EXPORT
71 SCIP* scip, /**< SCIP data structure */
72 SCIP_EXPR** expr, /**< pointer where to store expression */
73 int nchildren, /**< number of children */
74 SCIP_EXPR** children, /**< children */
75 SCIP_Real coefficient, /**< constant coefficient of product */
76 SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */
77 void* ownercreatedata /**< data to pass to ownercreate */
78 );
79
80/** @}
81 * @}
82 */
83
84#ifdef __cplusplus
85}
86#endif
87
88#endif /* __SCIP_EXPR_PROD_H__ */
#define SCIP_Real
Definition: def.h:173
SCIP_RETCODE SCIPcreateExprProduct(SCIP *scip, SCIP_EXPR **expr, int nchildren, SCIP_EXPR **children, SCIP_Real coefficient, SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), void *ownercreatedata)
SCIP_RETCODE SCIPincludeExprhdlrProduct(SCIP *scip)
SCIP callable library.
type and macro definitions related to algebraic expressions
#define SCIP_DECL_EXPR_OWNERCREATE(x)
Definition: type_expr.h:143
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63