-
Notifications
You must be signed in to change notification settings - Fork 356
/
doc.i
14804 lines (9256 loc) · 449 KB
/
doc.i
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File: index.xml
// File: classcasadi_1_1Assertion.xml
// File: classcasadi_1_1Bilin.xml
// File: classcasadi_1_1BinaryMX.xml
// File: classcasadi_1_1BinarySX.xml
// File: classcasadi_1_1Blocksqp.xml
// File: classcasadi_1_1BonminUserClass.xml
%feature("docstring") casadi::BonminUserClass "
[INTERNAL] C++ includes: bonmin_nlp.hpp ";
%feature("docstring")
casadi::BonminUserClass::finalize_solution(TMINLP::SolverReturn status,
Index n, const Number *x, Number obj_value) "
[INTERNAL] This method is called when the algorithm is complete so the TNLP
can store/write the solution
";
%feature("docstring") casadi::BonminUserClass::eval_g(Index n, const Number
*x, bool new_x, Index m, Number *g) "
[INTERNAL] Method to return the constraint residuals
";
%feature("docstring") casadi::BonminUserClass::eval_f(Index n, const Number
*x, bool new_x, Number &obj_value) "
[INTERNAL] Method to return the objective value
";
%feature("docstring")
casadi::BonminUserClass::get_constraints_linearity(Index m,
Ipopt::TNLP::LinearityType *const_types) "
[INTERNAL] ";
%feature("docstring") casadi::BonminUserClass::BonminUserClass(const
BonminInterface &bonminInterface, BonminMemory *mem) "
[INTERNAL] ";
%feature("docstring") casadi::BonminUserClass::get_starting_point(Index n,
bool init_x, Number *x, bool init_z, Number *z_L, Number *z_U, Index m, bool
init_lambda, Number *lambda) "
[INTERNAL] Method to return the starting point for the algorithm
";
%feature("docstring")
casadi::BonminUserClass::get_number_of_nonlinear_variables() "
[INTERNAL] Specify the number of variables that appear in the Hessian
";
%feature("docstring") casadi::BonminUserClass::eval_jac_g(Index n, const
Number *x, bool new_x, Index m, Index nele_jac, Index *iRow, Index *jCol,
Number *values) "
[INTERNAL] Method to return: 1) The structure of the Jacobian (if
\"values\" is NULL) 2) The values of the Jacobian (if \"values\" is not
NULL)
";
%feature("docstring")
casadi::BonminUserClass::intermediate_callback(AlgorithmMode mode, Index
iter, Number obj_value, Number inf_pr, Number inf_du, Number mu, Number
d_norm, Number regularization_size, Number alpha_du, Number alpha_pr, Index
ls_trials, const IpoptData *ip_data, IpoptCalculatedQuantities *ip_cq) "
[INTERNAL] This method is called at every iteration
";
%feature("docstring") casadi::BonminUserClass::eval_h(Index n, const Number
*x, bool new_x, Number obj_factor, Index m, const Number *lambda, bool
new_lambda, Index nele_hess, Index *iRow, Index *jCol, Number *values) "
[INTERNAL] Method to return: 1) The structure of the hessian of the
Lagrangian (if \"values\" is NULL) 2) The values of the hessian of the
Lagrangian (if \"values\" is not NULL)
";
%feature("docstring") casadi::BonminUserClass::get_variables_types(Index n,
VariableType *var_types) "
[INTERNAL] ";
%feature("docstring") casadi::BonminUserClass::~BonminUserClass "
[INTERNAL] ";
%feature("docstring")
casadi::BonminUserClass::get_list_of_nonlinear_variables(Index
num_nonlin_vars, Index *pos_nonlin_vars) "
[INTERNAL] Specify which variables that appear in the Hessian
";
%feature("docstring") casadi::BonminUserClass::get_bounds_info(Index n,
Number *x_l, Number *x_u, Index m, Number *g_l, Number *g_u) "
[INTERNAL] Method to return the bounds for my problem
";
%feature("docstring") casadi::BonminUserClass::sosConstraints() const "
[INTERNAL] ";
%feature("docstring") casadi::BonminUserClass::get_nlp_info(Index &n, Index
&m, Index &nnz_jac_g, Index &nnz_h_lag, TNLP::IndexStyleEnum &index_style) "
[INTERNAL] Method to return some info about the nlp
";
%feature("docstring") casadi::BonminUserClass::branchingInfo() const "
[INTERNAL] ";
%feature("docstring") casadi::BonminUserClass::eval_grad_f(Index n, const
Number *x, bool new_x, Number *grad_f) "
[INTERNAL] Method to return the gradient of the objective
";
%feature("docstring")
casadi::BonminUserClass::get_variables_linearity(Index n,
Ipopt::TNLP::LinearityType *var_types) "
[INTERNAL] ";
// File: classcasadi_1_1Call.xml
// File: classcasadi_1_1Callback.xml
%feature("docstring") casadi::Function::size2_in(int ind) const "
Get input dimension.
";
%feature("docstring") casadi::Function::size2_in(const std::string &iname)
const "
Get input dimension.
";
%feature("docstring") casadi::Function::call(const std::vector< DM > &arg,
std::vector< DM > &output_res, bool always_inline=false, bool
never_inline=false) "
Evaluate the function symbolically or numerically.
";
%feature("docstring") casadi::Function::call(const std::vector< SX > &arg,
std::vector< SX > &output_res, bool always_inline=false, bool
never_inline=false) "
Evaluate the function symbolically or numerically.
";
%feature("docstring") casadi::Function::call(const std::vector< MX > &arg,
std::vector< MX > &output_res, bool always_inline=false, bool
never_inline=false) "
Evaluate the function symbolically or numerically.
";
%feature("docstring") casadi::Function::call(const DMDict &arg, DMDict
&output_res, bool always_inline=false, bool never_inline=false) "
Evaluate the function symbolically or numerically.
";
%feature("docstring") casadi::Function::call(const SXDict &arg, SXDict
&output_res, bool always_inline=false, bool never_inline=false) "
Evaluate the function symbolically or numerically.
";
%feature("docstring") casadi::Function::call(const MXDict &arg, MXDict
&output_res, bool always_inline=false, bool never_inline=false) "
Evaluate the function symbolically or numerically.
";
%feature("docstring") casadi::Function::generate_dependencies(const
std::string &fname, const Dict &opts=Dict()) "
Export / Generate C code for the dependency function.
";
%feature("docstring") casadi::Callback::get_n_in() "
Get the number of inputs This function is called during construction.
";
%feature("docstring") casadi::Callback::get_n_out() "
Get the number of outputs This function is called during construction.
";
%feature("docstring") casadi::Function::size_in(int ind) const "
Get input dimension.
";
%feature("docstring") casadi::Function::size_in(const std::string &iname)
const "
Get input dimension.
";
%feature("docstring") casadi::Callback::Callback() "
Default constructor.
";
%feature("docstring") casadi::Callback::Callback(const Callback &obj) "
Copy constructor (throws an error)
";
%feature("docstring") casadi::Callback::get_name_in(int i) "
Get the sparsity of an input This function is called during construction.
";
%feature("docstring") casadi::Function::getWorkSize() const "
Get the length of the work vector.
";
%feature("docstring") casadi::Function::sz_arg() const "
[INTERNAL] Get required length of arg field.
";
%feature("docstring") casadi::Function::slice(const std::vector< int >
&order_in, const std::vector< int > &order_out, const Dict &opts=Dict()) "
returns a new function with a selection of inputs/outputs of the original
";
%feature("docstring") casadi::SharedObject::print(std::ostream
&stream=casadi::userOut(), bool trailing_newline=true) const "
Print a description of the object.
";
%feature("docstring") casadi::Function::has_function(const std::string
&fname) const "
";
%feature("docstring") casadi::Function::nnz_out() const "
Get number of output nonzeros.
For a particular output or for all of the outputs
";
%feature("docstring") casadi::Function::nnz_out(int ind) const "
Get number of output nonzeros.
For a particular output or for all of the outputs
";
%feature("docstring") casadi::Function::nnz_out(const std::string &oname)
const "
Get number of output nonzeros.
For a particular output or for all of the outputs
";
%feature("docstring") casadi::Function::factory(const std::string &name,
const std::vector< std::string > &s_in, const std::vector< std::string >
&s_out, const AuxOut &aux=AuxOut(), const Dict &opts=Dict()) const "
";
%feature("docstring") casadi::Function::print_free(std::ostream
&stream=casadi::userOut()) const "
Print free variables.
";
%feature("docstring") casadi::Function::free_sx() const "
Get all the free variables of the function.
";
%feature("docstring") casadi::Function::name_out() const "
Get output scheme.
";
%feature("docstring") casadi::Function::name_out(int ind) const "
Get output scheme name by index.
";
%feature("docstring") casadi::Function::nnz_in() const "
Get number of input nonzeros.
For a particular input or for all of the inputs
";
%feature("docstring") casadi::Function::nnz_in(int ind) const "
Get number of input nonzeros.
For a particular input or for all of the inputs
";
%feature("docstring") casadi::Function::nnz_in(const std::string &iname)
const "
Get number of input nonzeros.
For a particular input or for all of the inputs
";
%feature("docstring") casadi::Function::forward(const std::vector< MX >
&arg, const std::vector< MX > &res, const std::vector< std::vector< MX > >
&fseed, std::vector< std::vector< MX > > &output_fsens, bool
always_inline=false, bool never_inline=false) "
Create call to (cached) derivative function, forward mode.
";
%feature("docstring") casadi::Function::forward(const std::vector< SX >
&arg, const std::vector< SX > &res, const std::vector< std::vector< SX > >
&fseed, std::vector< std::vector< SX > > &output_fsens, bool
always_inline=false, bool never_inline=false) "
Create call to (cached) derivative function, forward mode.
";
%feature("docstring") casadi::Function::forward(const std::vector< DM >
&arg, const std::vector< DM > &res, const std::vector< std::vector< DM > >
&fseed, std::vector< std::vector< DM > > &output_fsens, bool
always_inline=false, bool never_inline=false) "
Create call to (cached) derivative function, forward mode.
";
%feature("docstring") casadi::Function::forward(int nfwd) "
Get a function that calculates nfwd forward derivatives.
Returns a function with n_in + n_out +nfwd*n_in inputs and nfwd*n_out
outputs. The first n_in inputs correspond to nondifferentiated inputs. The
next n_out inputs correspond to nondifferentiated outputs. and the last
nfwd*n_in inputs correspond to forward seeds, one direction at a time The
nfwd*n_out outputs correspond to forward sensitivities, one direction at a
time. * (n_in = n_in(), n_out = n_out())
The functions returned are cached, meaning that if called multiple timed
with the same value, then multiple references to the same function will be
returned.
";
%feature("docstring") casadi::Function::default_in(int ind) const "
Get default input value (NOTE: constant reference)
";
%feature("docstring") casadi::Callback::init() "
Initialize the object This function is called after the object construction
(for the whole class hierarchy) is complete, but before the finalization
step. It is called recursively for the whole class hierarchy, starting with
the lowest level.
";
%feature("docstring") casadi::Function::numel_out() const "
Get number of output elements.
For a particular output or for all of the outputs
";
%feature("docstring") casadi::Function::numel_out(int ind) const "
Get number of output elements.
For a particular output or for all of the outputs
";
%feature("docstring") casadi::Function::numel_out(const std::string &oname)
const "
Get number of output elements.
For a particular output or for all of the outputs
";
%feature("docstring") casadi::Function::print_dimensions(std::ostream
&stream=casadi::userOut()) const "
Print dimensions of inputs and outputs.
";
%feature("docstring") casadi::Function::generate(const std::string &fname,
const Dict &opts=Dict()) "
Export / Generate C code for the function.
";
%feature("docstring") casadi::Function::generate(const Dict &opts=Dict()) "
Export / Generate C code for the function.
";
%feature("docstring") casadi::Function::getAtomicInput(int k) const "
Get the (integer) input arguments of an atomic operation.
";
%feature("docstring") casadi::Function::printOption(const std::string
&name, std::ostream &stream=casadi::userOut()) const "
[DEPRECATED] printOption has been renamed print_option
";
%feature("docstring") casadi::Function::getAtomicInputReal(int k) const "
Get the floating point output argument of an atomic operation.
";
%feature("docstring") casadi::Function::checkInputs() const "
[INTERNAL] Check if the numerical values of the supplied bounds make sense.
";
%feature("docstring") casadi::SharedObject::is_null() const "
Is a null pointer?
";
%feature("docstring") casadi::Callback::get_n_reverse() const "
Return function that calculates adjoint derivatives reverse(nadj) returns a
cached instance if available, and calls Function get_reverse(int nadj) if
no cached version is available.
";
%feature("docstring") casadi::Function::type_name() const "
Get type name.
";
%feature("docstring") casadi::Function::jacobian(int iind=0, int oind=0,
bool compact=false, bool symmetric=false) "
Generate a Jacobian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The default behavior of this class is defined by the derived class. If
compact is set to true, only the nonzeros of the input and output
expressions are considered. If symmetric is set to true, the Jacobian being
calculated is known to be symmetric (usually a Hessian), which can be
exploited by the algorithm.
The generated Jacobian has one more output than the calling function
corresponding to the Jacobian and the same number of inputs.
";
%feature("docstring") casadi::Function::jacobian(const std::string &iind,
int oind=0, bool compact=false, bool symmetric=false) "
Generate a Jacobian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The default behavior of this class is defined by the derived class. If
compact is set to true, only the nonzeros of the input and output
expressions are considered. If symmetric is set to true, the Jacobian being
calculated is known to be symmetric (usually a Hessian), which can be
exploited by the algorithm.
The generated Jacobian has one more output than the calling function
corresponding to the Jacobian and the same number of inputs.
";
%feature("docstring") casadi::Function::jacobian(int iind, const
std::string &oind, bool compact=false, bool symmetric=false) "
Generate a Jacobian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The default behavior of this class is defined by the derived class. If
compact is set to true, only the nonzeros of the input and output
expressions are considered. If symmetric is set to true, the Jacobian being
calculated is known to be symmetric (usually a Hessian), which can be
exploited by the algorithm.
The generated Jacobian has one more output than the calling function
corresponding to the Jacobian and the same number of inputs.
";
%feature("docstring") casadi::Function::jacobian(const std::string &iind,
const std::string &oind, bool compact=false, bool symmetric=false) "
Generate a Jacobian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The default behavior of this class is defined by the derived class. If
compact is set to true, only the nonzeros of the input and output
expressions are considered. If symmetric is set to true, the Jacobian being
calculated is known to be symmetric (usually a Hessian), which can be
exploited by the algorithm.
The generated Jacobian has one more output than the calling function
corresponding to the Jacobian and the same number of inputs.
";
%feature("docstring") casadi::Function::sz_iw() const "
[INTERNAL] Get required length of iw field.
";
%feature("docstring") casadi::Function::set_reverse(const Function &fcn,
int nadj) "
Set a function that calculates nadj adjoint derivatives NOTE: Does not take
ownership, only weak references to the derivatives are kept internally.
";
%feature("docstring") casadi::Function::n_nodes() const "
Number of nodes in the algorithm.
";
%feature("docstring") casadi::Function::sx_out(int oind) const "
Get symbolic primitives equivalent to the output expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Function::sx_out(const std::string &oname)
const "
Get symbolic primitives equivalent to the output expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Function::sx_out() const "
Get symbolic primitives equivalent to the output expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Function::print_options(std::ostream
&stream=casadi::userOut()) const "
Print options to a stream.
";
%feature("docstring") casadi::Function::checkout() "
Checkout a memory object.
";
%feature("docstring") casadi::Function::reverse(const std::vector< MX >
&arg, const std::vector< MX > &res, const std::vector< std::vector< MX > >
&aseed, std::vector< std::vector< MX > > &output_asens, bool
always_inline=false, bool never_inline=false) "
Create call to (cached) derivative function, reverse mode.
";
%feature("docstring") casadi::Function::reverse(const std::vector< SX >
&arg, const std::vector< SX > &res, const std::vector< std::vector< SX > >
&aseed, std::vector< std::vector< SX > > &output_asens, bool
always_inline=false, bool never_inline=false) "
Create call to (cached) derivative function, reverse mode.
";
%feature("docstring") casadi::Function::reverse(const std::vector< DM >
&arg, const std::vector< DM > &res, const std::vector< std::vector< DM > >
&aseed, std::vector< std::vector< DM > > &output_asens, bool
always_inline=false, bool never_inline=false) "
Create call to (cached) derivative function, reverse mode.
";
%feature("docstring") casadi::Function::reverse(int nadj) "
Get a function that calculates nadj adjoint derivatives.
Returns a function with n_in + n_out +nadj*n_out inputs and nadj*n_in
outputs. The first n_in inputs correspond to nondifferentiated inputs. The
next n_out inputs correspond to nondifferentiated outputs. and the last
nadj*n_out inputs correspond to adjoint seeds, one direction at a time The
nadj*n_in outputs correspond to adjoint sensitivities, one direction at a
time. * (n_in = n_in(), n_out = n_out())
(n_in = n_in(), n_out = n_out())
The functions returned are cached, meaning that if called multiple timed
with the same value, then multiple references to the same function will be
returned.
";
%feature("docstring") casadi::Callback::~Callback "
Destructor.
";
%feature("docstring") casadi::Function::getAtomicOutput(int k) const "
Get the (integer) output argument of an atomic operation.
";
%feature("docstring") casadi::Function::hessian(int iind=0, int oind=0) "
Generate a Hessian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The generated Hessian has two more outputs than the calling function
corresponding to the Hessian and the gradients.
";
%feature("docstring") casadi::Function::hessian(const std::string &iind,
int oind=0) "
Generate a Hessian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The generated Hessian has two more outputs than the calling function
corresponding to the Hessian and the gradients.
";
%feature("docstring") casadi::Function::hessian(int iind, const std::string
&oind) "
Generate a Hessian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The generated Hessian has two more outputs than the calling function
corresponding to the Hessian and the gradients.
";
%feature("docstring") casadi::Function::hessian(const std::string &iind,
const std::string &oind) "
Generate a Hessian function of output oind with respect to input iind.
Parameters:
-----------
iind: The index of the input
oind: The index of the output
The generated Hessian has two more outputs than the calling function
corresponding to the Hessian and the gradients.
";
%feature("docstring") casadi::Function::conic_debug(const std::string
&filename) const "
Generate native code in the interfaced language for debugging
";
%feature("docstring") casadi::Function::conic_debug(std::ostream &file)
const "
Generate native code in the interfaced language for debugging
";
%feature("docstring") casadi::PrintableObject< SharedObject
>::getDescription() const "
Return a string with a description (for SWIG)
";
%feature("docstring") casadi::Function::setFullJacobian(const Function
&jac) "
Set the Jacobian of all the input nonzeros with respect to all output
nonzeros NOTE: Does not take ownership, only weak references to the Jacobian
are kept internally
";
%feature("docstring") casadi::SharedObject::repr(std::ostream
&stream=casadi::userOut(), bool trailing_newline=true) const "
Print a representation of the object.
";
%feature("docstring") casadi::Function::index_out(const std::string &name)
const "
Find the index for a string describing a particular entry of an output
scheme.
example: schemeEntry(\"x_opt\") -> returns NLPSOL_X if FunctionInternal
adheres to SCHEME_NLPINput
";
%feature("docstring") casadi::Callback::construct(const std::string &name,
const Dict &opts=Dict()) "
Construct internal object This is the step that actually construct the
internal object, as the class constructor only creates a null pointer. It
should be called from the user constructor.
";
%feature("docstring") casadi::Callback::get_n_forward() const "
Return function that calculates forward derivatives forward(nfwd) returns a
cached instance if available, and calls Function get_forward(int nfwd) if
no cached version is available.
";
%feature("docstring") casadi::Function::sx_in(int iind) const "
Get symbolic primitives equivalent to the input expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Function::sx_in(const std::string &iname)
const "
Get symbolic primitives equivalent to the input expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Function::sx_in() const "
Get symbolic primitives equivalent to the input expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Callback::get_forward(const std::string
&name, int nfwd, Dict &opts) "
Return function that calculates forward derivatives forward(nfwd) returns a
cached instance if available, and calls Function get_forward(int nfwd) if
no cached version is available.
";
%feature("docstring") casadi::Function::sparsity_jac(int iind=0, int
oind=0, bool compact=false, bool symmetric=false) "
Get, if necessary generate, the sparsity of a Jacobian block
";
%feature("docstring") casadi::Function::sparsity_jac(const std::string
&iind, int oind=0, bool compact=false, bool symmetric=false) "
Get, if necessary generate, the sparsity of a Jacobian block
";
%feature("docstring") casadi::Function::sparsity_jac(int iind, const
std::string &oind, bool compact=false, bool symmetric=false) "
Get, if necessary generate, the sparsity of a Jacobian block
";
%feature("docstring") casadi::Function::sparsity_jac(const std::string
&iind, const std::string &oind, bool compact=false, bool symmetric=false) "
Get, if necessary generate, the sparsity of a Jacobian block
";
%feature("docstring") casadi::Function::rootfinder_fun() "
Access rhs function for a rootfinder.
";
%feature("docstring") casadi::Function::size1_out(int ind) const "
Get output dimension.
";
%feature("docstring") casadi::Function::size1_out(const std::string &oname)
const "
Get output dimension.
";
%feature("docstring") casadi::Function::spCanEvaluate(bool fwd) "
[INTERNAL] Is the class able to propagate seeds through the algorithm?
(for usage, see the example propagating_sparsity.cpp)
";
%feature("docstring") casadi::Callback::has_jacobian() const "
Return Jacobian of all input elements with respect to all output elements.
";
%feature("docstring") casadi::Callback::finalize() "
Finalize the object This function is called after the construction and init
steps are completed, but before user functions are called. It is called
recursively for the whole class hierarchy, starting with the highest level.
";
%feature("docstring") casadi::Function::size2_out(int ind) const "
Get output dimension.
";
%feature("docstring") casadi::Function::size2_out(const std::string &oname)
const "
Get output dimension.
";
%feature("docstring") casadi::Function::mx_in(int ind) const "
Get symbolic primitives equivalent to the input expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Function::mx_in(const std::string &iname)
const "
Get symbolic primitives equivalent to the input expressions There is no
guarantee that subsequent calls return unique answers.
";
%feature("docstring") casadi::Function::mx_in() const "
Get symbolic primitives equivalent to the input expressions There is no
guarantee that subsequent calls return unique answers.
";