1    	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2    	/*                                                                           */
3    	/*                  This file is part of the program and library             */
4    	/*         SCIP --- Solving Constraint Integer Programs                      */
5    	/*                                                                           */
6    	/*  Copyright (c) 2002-2023 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_trig.h
26   	 * @ingroup EXPRHDLRS
27   	 * @brief  handler for sin expressions
28   	 * @author Fabian Wegscheider
29   	 */
30   	
31   	/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32   	
33   	#ifndef __SCIP_EXPR_TRIG_H__
34   	#define __SCIP_EXPR_TRIG_H__
35   	
36   	#include "scip/scip.h"
37   	#include "scip/type_expr.h"
38   	
39   	#ifdef __cplusplus
40   	extern "C" {
41   	#endif
42   	
43   	/** creates the handler for sin expressions and includes it into SCIP
44   	 *
45   	 * @ingroup ExprhdlrIncludes
46   	 */
47   	SCIP_EXPORT
48   	SCIP_RETCODE SCIPincludeExprhdlrSin(
49   	   SCIP*                 scip                /**< SCIP data structure */
50   	   );
51   	
52   	/** creates the handler for cos expressions and includes it into SCIP
53   	 *
54   	 * @ingroup ExprhdlrIncludes
55   	 */
56   	SCIP_EXPORT
57   	SCIP_RETCODE SCIPincludeExprhdlrCos(
58   	   SCIP*                 scip                /**< SCIP data structure */
59   	   );
60   	
61   	/**@addtogroup EXPRHDLRS
62   	 *
63   	 * @{
64   	 *
65   	 * @name Sine and Cosine expression
66   	 *
67   	 * These expression handlers provide the sine and cosine functions, that is,
68   	 * \f[
69   	 *   x \mapsto \sin(x)
70   	 * \f]
71   	 * and
72   	 * \f[
73   	 *   x \mapsto \cos(x).
74   	 * \f]
75   	 *
76   	 * @{
77   	 */
78   	
79   	/** creates a sin expression */
80   	SCIP_EXPORT
81   	SCIP_RETCODE SCIPcreateExprSin(
82   	   SCIP*                 scip,               /**< SCIP data structure */
83   	   SCIP_EXPR**           expr,               /**< pointer where to store expression */
84   	   SCIP_EXPR*            child,              /**< single child */
85   	   SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */
86   	   void*                 ownercreatedata     /**< data to pass to ownercreate */
87   	   );
88   	
89   	/** creates a cos expression */
90   	SCIP_EXPORT
91   	SCIP_RETCODE SCIPcreateExprCos(
92   	   SCIP*                 scip,               /**< SCIP data structure */
93   	   SCIP_EXPR**           expr,               /**< pointer where to store expression */
94   	   SCIP_EXPR*            child,              /**< single child */
95   	   SCIP_DECL_EXPR_OWNERCREATE((*ownercreate)), /**< function to call to create ownerdata */
96   	   void*                 ownercreatedata     /**< data to pass to ownercreate */
97   	   );
98   	
99   	/** indicates whether expression is of sine-type */
100  	SCIP_EXPORT
101  	SCIP_Bool SCIPisExprSin(
102  	   SCIP*                 scip,               /**< SCIP data structure */
103  	   SCIP_EXPR*            expr                /**< expression */
104  	   );
105  	
106  	/** indicates whether expression is of cosine-type */
107  	SCIP_EXPORT
108  	SCIP_Bool SCIPisExprCos(
109  	   SCIP*                 scip,               /**< SCIP data structure */
110  	   SCIP_EXPR*            expr                /**< expression */
111  	   );
112  	
113  	/** @}
114  	  * @}
115  	  */
116  	
117  	#ifdef __cplusplus
118  	}
119  	#endif
120  	
121  	#endif /* __SCIP_EXPR_TRIG_H__ */
122