-
Notifications
You must be signed in to change notification settings - Fork 25
/
polynomial.hpp
1971 lines (1930 loc) · 93.1 KB
/
polynomial.hpp
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
/* Copyright 2009-2017 Francesco Biscani (bluescarni@gmail.com)
This file is part of the Piranha library.
The Piranha library is free software; you can redistribute it and/or modify
it under the terms of either:
* the GNU Lesser General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your
option) any later version.
or
* the GNU General Public License as published by the Free Software
Foundation; either version 3 of the License, or (at your option) any
later version.
or both in parallel, as here.
The Piranha library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received copies of the GNU General Public License and the
GNU Lesser General Public License along with the Piranha library. If not,
see https://www.gnu.org/licenses/. */
#ifndef PIRANHA_POLYNOMIAL_HPP
#define PIRANHA_POLYNOMIAL_HPP
#include <algorithm>
#include <cmath> // For std::ceil.
#include <cstddef>
#include <functional>
#include <initializer_list>
#include <iterator>
#include <limits>
#include <map>
#include <mutex>
#include <numeric>
#include <stdexcept>
#include <string>
#include <tuple>
#include <type_traits>
#include <utility>
#include <vector>
#include <boost/numeric/conversion/cast.hpp>
#include <mp++/rational.hpp>
#include <piranha/base_series_multiplier.hpp>
#include <piranha/config.hpp>
#include <piranha/detail/atomic_flag_array.hpp>
#include <piranha/detail/cf_mult_impl.hpp>
#include <piranha/detail/debug_access.hpp>
#include <piranha/detail/divisor_series_fwd.hpp>
#include <piranha/detail/init.hpp>
#include <piranha/detail/parallel_vector_transform.hpp>
#include <piranha/detail/poisson_series_fwd.hpp>
#include <piranha/detail/polynomial_fwd.hpp>
#include <piranha/detail/safe_integral_arith.hpp>
#include <piranha/detail/sfinae_types.hpp>
#include <piranha/exceptions.hpp>
#include <piranha/forwarding.hpp>
#include <piranha/integer.hpp>
#include <piranha/ipow_substitutable_series.hpp>
#include <piranha/is_cf.hpp>
#include <piranha/key/key_degree.hpp>
#include <piranha/key/key_is_one.hpp>
#include <piranha/key/key_ldegree.hpp>
#include <piranha/key_is_multipliable.hpp>
#include <piranha/kronecker_array.hpp>
#include <piranha/kronecker_monomial.hpp>
#include <piranha/math.hpp>
#include <piranha/math/degree.hpp>
#include <piranha/math/is_zero.hpp>
#include <piranha/math/pow.hpp>
#include <piranha/monomial.hpp>
#include <piranha/power_series.hpp>
#include <piranha/safe_cast.hpp>
#include <piranha/series.hpp>
#include <piranha/series_multiplier.hpp>
#include <piranha/settings.hpp>
#include <piranha/substitutable_series.hpp>
#include <piranha/symbol_utils.hpp>
#include <piranha/t_substitutable_series.hpp>
#include <piranha/thread_pool.hpp>
#include <piranha/trigonometric_series.hpp>
#include <piranha/tuning.hpp>
#include <piranha/type_traits.hpp>
namespace piranha
{
namespace detail
{
// Tag for polynomial instances.
struct polynomial_tag {
};
// Type trait to check the key type in polynomial.
template <typename T>
struct is_polynomial_key {
static const bool value = false;
};
template <typename T>
struct is_polynomial_key<kronecker_monomial<T>> {
static const bool value = true;
};
template <typename T, typename U>
struct is_polynomial_key<monomial<T, U>> {
static const bool value = true;
};
// Implementation detail to check if the monomial key supports the is_linear() method.
template <typename Key>
struct key_has_is_linear {
template <typename U>
using is_linear_t = decltype(std::declval<const U &>().is_linear(std::declval<const symbol_fset &>()));
static const bool value = std::is_same<detected_t<is_linear_t, Key>, std::pair<bool, symbol_idx>>::value;
};
}
/// Polynomial class.
/**
* This class represents multivariate polynomials as collections of multivariate polynomial terms.
* \p Cf represents the ring over which the polynomial is defined, while \p Key represents the monomial type.
*
* Polynomials support an automatic degree-based truncation mechanism, disabled by default, which comes into play during
* polynomial multiplication. It allows to discard automatically all those terms, generated during series
* multiplication, whose total or partial degree is greater than a specified limit. This mechanism can be configured via
* a set of thread-safe static methods, and it is enabled if:
* - the total and partial degree of the series are represented by the same type \p D,
* - all the truncation-related requirements in piranha::power_series are satsified,
* - the type \p D is equality-comparable, subtractable and the type resulting from the subtraction is still \p D.
*
* This class satisfies the piranha::is_series and piranha::is_cf type traits.
*
* ## Type requirements ##
*
* \p Cf must be suitable for use in piranha::series as first template argument,
* \p Key must be an instance of either piranha::monomial or piranha::kronecker_monomial.
*
* ## Exception safety guarantee ##
*
* This class provides the same guarantee as the base series type it derives from.
*
* ## Move semantics ##
*
* Move semantics is equivalent to the move semantics of the base series type it derives from.
*/
template <typename Cf, typename Key>
class polynomial
: public power_series<
trigonometric_series<ipow_substitutable_series<
substitutable_series<t_substitutable_series<series<Cf, Key, polynomial<Cf, Key>>, polynomial<Cf, Key>>,
polynomial<Cf, Key>>,
polynomial<Cf, Key>>>,
polynomial<Cf, Key>>,
detail::polynomial_tag
{
// Check the key.
PIRANHA_TT_CHECK(detail::is_polynomial_key, Key);
// Make friend with debug class.
template <typename>
friend class debug_access;
// Make friend with all poly types.
template <typename, typename>
friend class polynomial;
// Make friend with Poisson series.
template <typename>
friend class poisson_series;
// Make friend with divisor series.
template <typename, typename>
friend class divisor_series;
// The base class.
using base = power_series<
trigonometric_series<ipow_substitutable_series<
substitutable_series<t_substitutable_series<series<Cf, Key, polynomial<Cf, Key>>, polynomial<Cf, Key>>,
polynomial<Cf, Key>>,
polynomial<Cf, Key>>>,
polynomial<Cf, Key>>;
// String constructor.
template <typename Str>
void construct_from_string(Str &&str)
{
using term_type = typename base::term_type;
// Insert the symbol.
this->m_symbol_set.emplace_hint(this->m_symbol_set.end(), std::forward<Str>(str));
// Construct and insert the term.
this->insert(term_type(Cf(1), typename term_type::key_type{1}));
}
template <
typename T = Key,
enable_if_t<conjunction<detail::key_has_is_linear<T>, is_safely_castable<const Cf &, integer>>::value, int> = 0>
std::map<std::string, integer> integral_combination() const
{
std::map<std::string, integer> retval;
for (auto it = this->m_container.begin(); it != this->m_container.end(); ++it) {
const auto p = it->m_key.is_linear(this->m_symbol_set);
if (unlikely(!p.first)) {
piranha_throw(std::invalid_argument, "polynomial is not an integral linear combination");
}
retval[*(this->m_symbol_set.nth(p.second))] = piranha::safe_cast<integer>(it->m_cf);
}
return retval;
}
template <typename T = Key, enable_if_t<disjunction<negation<detail::key_has_is_linear<T>>,
negation<is_safely_castable<const Cf &, integer>>>::value,
int> = 0>
std::map<std::string, integer> integral_combination() const
{
piranha_throw(std::invalid_argument,
"the polynomial type does not support the extraction of a linear combination");
}
// Integration utils.
// Empty for SFINAE.
template <typename T, typename = void>
struct integrate_type_ {
};
// The type resulting from the integration of the key of series T.
template <typename T>
using key_integrate_type
= decltype(std::declval<const typename T::term_type::key_type &>()
.integrate(std::declval<const std::string &>(), std::declval<const symbol_fset &>())
.first);
// Basic integration requirements for series T, to be satisfied both when the coefficient is integrable
// and when it is not. ResT is the type of the result of the integration.
template <typename T, typename ResT>
using basic_integrate_requirements = enable_if_t<
// Coefficient differentiable, and can call is_zero on the result.
is_is_zero_type<addlref_t<const decltype(math::partial(std::declval<const typename T::term_type::cf_type &>(),
std::declval<const std::string &>()))>>::value
&&
// The key is integrable.
true_tt<key_integrate_type<T>>::value &&
// The result needs to be addable in-place.
is_addable_in_place<ResT>::value &&
// It also needs to be ctible from zero.
std::is_constructible<ResT, int>::value>;
// Non-integrable coefficient.
template <typename T>
using nic_res_type = decltype((std::declval<const T &>() * std::declval<const typename T::term_type::cf_type &>())
/ std::declval<const key_integrate_type<T> &>());
template <typename T>
struct integrate_type_<
T, typename std::enable_if<!is_integrable<typename T::term_type::cf_type>::value
&& true_tt<basic_integrate_requirements<T, nic_res_type<T>>>::value>::type> {
using type = nic_res_type<T>;
};
// Integrable coefficient.
// The type resulting from the differentiation of the key of series T.
template <typename T>
using key_partial_type
= decltype(std::declval<const typename T::term_type::key_type &>()
.partial(std::declval<const symbol_idx &>(), std::declval<const symbol_fset &>())
.first);
// Type resulting from the integration of the coefficient.
template <typename T>
using i_cf_type = decltype(
math::integrate(std::declval<const typename T::term_type::cf_type &>(), std::declval<const std::string &>()));
// Type above, multiplied by the type coming out of the derivative of the key.
template <typename T>
using i_cf_type_p = decltype(std::declval<const i_cf_type<T> &>() * std::declval<const key_partial_type<T> &>());
// Final series type.
template <typename T>
using ic_res_type = decltype(std::declval<const i_cf_type_p<T> &>() * std::declval<const T &>());
template <typename T>
struct integrate_type_<
T, typename std::enable_if<
is_integrable<typename T::term_type::cf_type>::value
&& true_tt<basic_integrate_requirements<T, ic_res_type<T>>>::value &&
// We need to be able to add the non-integrable type.
is_addable_in_place<ic_res_type<T>, nic_res_type<T>>::value &&
// We need to be able to compute the partial degree and cast it to integer.
is_safely_castable<addlref_t<const decltype(piranha::key_degree(
std::declval<const typename T::term_type::key_type &>(),
std::declval<const symbol_idx_fset &>(), std::declval<const symbol_fset &>()))>,
integer>::value
&&
// This is required in the initialisation of the return value.
std::is_constructible<i_cf_type_p<T>, i_cf_type<T>>::value &&
// We need to be able to assign the integrated coefficient times key partial.
std::is_assignable<i_cf_type_p<T> &, i_cf_type_p<T>>::value &&
// Needs math::negate().
has_negate<i_cf_type_p<T>>::value>::type> {
using type = ic_res_type<T>;
};
// Final typedef.
template <typename T>
using integrate_type = typename std::enable_if<is_returnable<typename integrate_type_<T>::type>::value,
typename integrate_type_<T>::type>::type;
// Integration with integrable coefficient.
template <typename T = polynomial>
integrate_type<T> integrate_impl(const std::string &s, const typename base::term_type &term,
const std::true_type &) const
{
typedef typename base::term_type term_type;
typedef typename term_type::cf_type cf_type;
typedef typename term_type::key_type key_type;
// Get the partial degree of the monomial in integral form.
integer degree;
const auto idx = symbol_idx_fset{ss_index_of(this->m_symbol_set, s)};
try {
// Check if s is actually in the symbol set or not.
if (*idx.begin() < this->m_symbol_set.size()) {
degree = piranha::safe_cast<integer>(piranha::key_degree(term.m_key, idx, this->m_symbol_set));
} else {
degree = 0;
}
} catch (const safe_cast_failure &) {
piranha_throw(std::invalid_argument,
"unable to perform polynomial integration: cannot extract the integral form of an exponent");
}
// If the degree is negative, integration by parts won't terminate.
if (degree.sgn() < 0) {
piranha_throw(std::invalid_argument,
"unable to perform polynomial integration: negative integral exponent");
}
polynomial tmp;
tmp.set_symbol_set(this->m_symbol_set);
key_type tmp_key = term.m_key;
tmp.insert(term_type(cf_type(1), tmp_key));
i_cf_type_p<T> i_cf(math::integrate(term.m_cf, s));
integrate_type<T> retval(i_cf * tmp);
for (integer i(1); i <= degree; ++i) {
// Update coefficient and key. These variables are persistent across loop iterations.
auto partial_key = tmp_key.partial(*idx.begin(), this->m_symbol_set);
i_cf = math::integrate(i_cf, s) * std::move(partial_key.first);
// Account for (-1)**i.
math::negate(i_cf);
// Build the other factor from the derivative of the monomial.
tmp = polynomial{};
tmp.set_symbol_set(this->m_symbol_set);
tmp_key = std::move(partial_key.second);
// NOTE: don't move tmp_key, as it needs to hold a valid value
// for the next loop iteration.
tmp.insert(term_type(cf_type(1), tmp_key));
retval += i_cf * tmp;
}
return retval;
}
// Integration with non-integrable coefficient.
template <typename T = polynomial>
integrate_type<T> integrate_impl(const std::string &, const typename base::term_type &,
const std::false_type &) const
{
piranha_throw(std::invalid_argument,
"unable to perform polynomial integration: coefficient type is not integrable");
}
// Template alias for use in pow() overload. Will check via SFINAE that the base pow() method can be called with
// argument T and that exponentiation of key type is legal.
template <typename T>
using key_pow_t
= decltype(std::declval<Key const &>().pow(std::declval<const T &>(), std::declval<const symbol_fset &>()));
template <typename T>
using pow_ret_type = enable_if_t<is_detected<key_pow_t, T>::value,
decltype(std::declval<series<Cf, Key, polynomial<Cf, Key>> const &>().pow(
std::declval<const T &>()))>;
// Invert utils.
template <typename Series>
using inverse_type = decltype(std::declval<const Series &>().pow(-1));
// Auto-truncation machinery.
// The degree and partial degree types, detected via piranha::degree().
template <typename T>
using degree_type = decltype(piranha::degree(std::declval<const T &>()));
template <typename T>
using pdegree_type = decltype(piranha::degree(std::declval<const T &>(), std::declval<const symbol_fset &>()));
// Enablers for auto-truncation: degree and partial degree must be the same, series must support
// math::truncate_degree(), degree type must be subtractable and yield the same type.
template <typename T>
using at_degree_enabler = typename std::enable_if<
std::is_same<degree_type<T>, pdegree_type<T>>::value && has_truncate_degree<T, degree_type<T>>::value
&& std::is_same<decltype(std::declval<const degree_type<T> &>() - std::declval<const degree_type<T> &>()),
degree_type<T>>::value
&& is_equality_comparable<const degree_type<T> &>::value,
int>::type;
// For the setter, we need the above plus we need to be able to convert safely U to the degree type.
template <typename T, typename U>
using at_degree_set_enabler = typename std::enable_if<
true_tt<at_degree_enabler<T>>::value && is_safely_castable<const U &, degree_type<T>>::value, int>::type;
// This needs to be separate from the other static inits because we don't have anything to init
// if the series does not support degree computation.
// NOTE: here the important thing is that this method does not return the same object for different series types,
// as the intent of the truncation mechanism is that each polynomial type has its own settings.
// We need to keep this in mind if we need static resources that must be unique for the series type, sometimes
// adding the Derived series as template argument in a toolbox might actually be necessary because of this. Note
// that, contrary to the, e.g., custom derivatives map in series.hpp here we don't care about the type of T - we
// just need to be able to extract the term type from it.
template <typename T = polynomial>
static degree_type<T> &get_at_degree_max()
{
// Init to zero for peace of mind - though this should never be accessed
// if the auto-truncation is not used.
static degree_type<T> at_degree_max(0);
return at_degree_max;
}
// Enabler for string construction.
template <typename Str>
using str_enabler =
typename std::enable_if<std::is_same<typename std::decay<Str>::type, std::string>::value
|| std::is_same<typename std::decay<Str>::type, char *>::value
|| std::is_same<typename std::decay<Str>::type, const char *>::value,
int>::type;
// Implementation of find_cf().
template <typename T>
using find_cf_enabler = enable_if_t<
conjunction<is_input_range<T>,
std::is_constructible<typename base::term_type::key_type, addlref_t<detected_t<begin_adl::type, T>>,
addlref_t<detected_t<begin_adl::type, T>>, const symbol_fset &>>::value,
int>;
template <typename T>
using find_cf_init_list_enabler = find_cf_enabler<std::initializer_list<T> &>;
template <typename Iterator>
Cf find_cf_impl(Iterator begin, Iterator end) const
{
typename base::term_type tmp_term{Cf(0), Key(begin, end, this->m_symbol_set)};
auto it = this->m_container.find(tmp_term);
if (it == this->m_container.end()) {
return Cf(0);
}
return it->m_cf;
}
// Enabler for untruncated multiplication.
template <typename T>
using um_enabler =
typename std::enable_if<std::is_same<T, decltype(std::declval<const T &>() * std::declval<const T &>())>::value,
int>::type;
// Enabler for truncated multiplication.
template <typename T, typename U>
using tm_enabler =
typename std::enable_if<std::is_same<T, decltype(std::declval<const T &>() * std::declval<const T &>())>::value
&& is_safely_castable<const U &, degree_type<T>>::value
&& true_tt<at_degree_enabler<T>>::value,
int>::type;
// Common bits for truncated/untruncated multiplication. Will do the usual merging of the symbol sets
// before calling the runner functor, which performs the actual multiplication.
template <typename Functor>
static polynomial um_tm_implementation(const polynomial &p1, const polynomial &p2, const Functor &runner)
{
return series_merge_f(p1, p2, runner);
}
// Helper function to clear the pow cache when a new auto truncation limit is set.
template <typename T>
static void truncation_clear_pow_cache(int mode, const T &max_degree, const symbol_fset &names)
{
// The pow cache is cleared only if we are actually changing the truncation settings.
if (s_at_degree_mode != mode || get_at_degree_max() != max_degree || names != s_at_degree_names) {
polynomial::clear_pow_cache();
}
}
public:
/// Series rebind alias.
template <typename Cf2>
using rebind = polynomial<Cf2, Key>;
/// Defaulted default constructor.
/**
* Will construct a polynomial with zero terms.
*/
polynomial() = default;
/// Defaulted copy constructor.
polynomial(const polynomial &) = default;
/// Defaulted move constructor.
polynomial(polynomial &&) = default;
/// Constructor from symbol name.
/**
* \note
* This template constructor is enabled only if the decay type of \p Str is a C or C++ string.
*
* Will construct a univariate polynomial made of a single term with unitary coefficient and exponent, representing
* the symbolic variable \p name. The type of \p name must be a string type (either C or C++).
*
* @param name name of the symbolic variable that the polynomial will represent.
*
* @throws unspecified any exception thrown by:
* - the public interface of piranha::symbol_fset,
* - the invoked constructor of the coefficient type,
* - the invoked constructor of the key type,
* - the constructor of the term type from coefficient and key,
* - piranha::series::insert().
*/
template <typename Str, str_enabler<Str> = 0>
explicit polynomial(Str &&name) : base()
{
construct_from_string(std::forward<Str>(name));
}
PIRANHA_FORWARDING_CTOR(polynomial, base)
/// Trivial destructor.
~polynomial()
{
PIRANHA_TT_CHECK(is_cf, polynomial);
PIRANHA_TT_CHECK(is_series, polynomial);
}
/// Copy assignment operator.
/**
* @param other the assignment argument.
*
* @return a reference to \p this.
*
* @throws unspecified any exception thrown by the assignment operator of the base class.
*/
polynomial &operator=(const polynomial &other) = default;
/// Move assignment operator.
/**
* @param other the assignment argument.
*
* @return a reference to \p this.
*/
polynomial &operator=(polynomial &&other) = default;
PIRANHA_FORWARDING_ASSIGNMENT(polynomial, base)
/// Override default exponentiation method.
/**
* \note
* This method is enabled only if piranha::series::pow() can be called with exponent \p x
* and the key type can be raised to the power of \p x via its exponentiation method.
*
* This exponentiation override will check if the polynomial consists of a single-term with non-unitary
* key. In that case, the return polynomial will consist of a single term with coefficient computed via
* piranha::pow() and key computed via the monomial exponentiation method. Otherwise, the base
* (i.e., default) exponentiation method will be used.
*
* @param x exponent.
*
* @return \p this to the power of \p x.
*
* @throws unspecified any exception thrown by:
* - piranha::key_is_one() and the exponentiation methods of the key type,
* - piranha::pow(),
* - construction of coefficient, key and term,
* - piranha::series::insert() , piranha::series::set_symbol_set() and piranha::series::pow().
*/
template <typename T>
pow_ret_type<T> pow(const T &x) const
{
using ret_type = pow_ret_type<T>;
typedef typename ret_type::term_type term_type;
typedef typename term_type::cf_type cf_type;
typedef typename term_type::key_type key_type;
if (this->size() == 1u && !piranha::key_is_one(this->m_container.begin()->m_key, this->m_symbol_set)) {
cf_type cf(piranha::pow(this->m_container.begin()->m_cf, x));
key_type key(this->m_container.begin()->m_key.pow(x, this->m_symbol_set));
ret_type retval;
retval.set_symbol_set(this->m_symbol_set);
retval.insert(term_type(std::move(cf), std::move(key)));
return retval;
}
return static_cast<series<Cf, Key, polynomial<Cf, Key>> const *>(this)->pow(x);
}
/// Inversion.
/**
* \note
* This method is enabled only if <tt>piranha::polynomial::pow(-1)</tt> is a well-formed
* expression.
*
* @return the calling polynomial raised to -1 using piranha::polynomial::pow().
*
* @throws unspecified any exception thrown by piranha::polynomial::pow().
*/
template <typename Series = polynomial>
inverse_type<Series> invert() const
{
return this->pow(-1);
}
/// Integration.
/**
* \note
* This method is enabled only if the algorithm described below is supported by all the involved types.
*
* This method will attempt to compute the antiderivative of the polynomial term by term. If the term's coefficient
* does not depend on
* the integration variable, the result will be calculated via the integration of the corresponding monomial.
* Integration with respect to a variable appearing to the power of -1 will fail.
*
* Otherwise, a strategy of integration by parts is attempted, its success depending on the integrability
* of the coefficient and on the value of the exponent of the integration variable. The integration will
* fail if the exponent is negative or non-integral.
*
* @param name integration variable.
*
* @return the antiderivative of \p this with respect to \p name.
*
* @throws std::invalid_argument if the integration procedure fails.
* @throws unspecified any exception thrown by:
* - the public interface of piranha::symbol_fset,
* - piranha::math::partial(), piranha::is_zero(), piranha::math::integrate(), piranha::safe_cast()
* and piranha::math::negate(),
* - term construction,
* - coefficient construction, assignment and arithmetics,
* - integration, construction, assignment, differentiation and degree querying methods of the key type,
* - insert(),
* - series arithmetics.
*/
template <typename T = polynomial>
integrate_type<T> integrate(const std::string &name) const
{
typedef typename base::term_type term_type;
typedef typename term_type::cf_type cf_type;
integrate_type<T> retval(0);
// A copy of the current symbol set plus name. If name is
// in the set already, it will be just a copy.
const auto aug_ss = [this, &name]() -> symbol_fset {
symbol_fset tmp_ss(this->m_symbol_set);
tmp_ss.insert(name);
return tmp_ss;
}();
const auto it_f = this->m_container.end();
for (auto it = this->m_container.begin(); it != it_f; ++it) {
// If the derivative of the coefficient is null, we just need to deal with
// the integration of the key.
if (piranha::is_zero(math::partial(it->m_cf, name))) {
polynomial tmp;
tmp.set_symbol_set(aug_ss);
auto key_int = it->m_key.integrate(name, this->m_symbol_set);
tmp.insert(term_type(cf_type(1), std::move(key_int.second)));
retval += (tmp * it->m_cf) / key_int.first;
} else {
retval += integrate_impl(name, *it, std::integral_constant<bool, is_integrable<cf_type>::value>{});
}
}
return retval;
}
/// Set total-degree-based auto-truncation.
/**
* \note
* This method is available only if the requisites outlined in piranha::polynomial are satisfied
* and if \p U can be safely cast to the degree type.
*
* Setup the degree-based auto-truncation mechanism to truncate according to the total maximum degree.
* If the new auto truncation settings are different from the currently active ones, the natural power cache
* defined in piranha::series will be cleared.
*
* @param max_degree maximum total degree that will be retained during automatic truncation.
*
* @throws unspecified any exception thrown by:
* - threading primitives,
* - piranha::safe_cast(),
* - the constructor of the degree type.
*/
template <typename U, typename T = polynomial, at_degree_set_enabler<T, U> = 0>
static void set_auto_truncate_degree(const U &max_degree)
{
// Init out for exception safety.
auto new_degree = piranha::safe_cast<degree_type<T>>(max_degree);
// Initialisation of function-level statics is thread-safe, no need to lock. We get
// a ref before the lock because the initialisation of the static could throw in principle,
// and we want the section after the lock to be exception-free.
auto &at_dm = get_at_degree_max();
std::lock_guard<std::mutex> lock(s_at_degree_mutex);
// NOTE: here in principle there could be an exception thrown as a consequence of the degree comparison.
// This is not a problem as at this stage no setting has been modified.
truncation_clear_pow_cache(1, new_degree, symbol_fset{});
s_at_degree_mode = 1;
// NOTE: the degree type of polys satisfies is_container_element, so move assignment is noexcept.
at_dm = std::move(new_degree);
// This should not throw (a vector of strings, destructors and deallocation should be noexcept).
s_at_degree_names.clear();
}
/// Set partial-degree-based auto-truncation.
/**
* \note
* This method is available only if the requisites outlined in piranha::polynomial are satisfied
* and if \p U can be safely cast to the degree type.
*
* Setup the degree-based auto-truncation mechanism to truncate according to the partial degree.
* If the new auto truncation settings are different from the currently active ones, the natural power cache
* defined in piranha::series will be cleared.
*
* @param max_degree maximum partial degree that will be retained during automatic truncation.
* @param names names of the variables that will be considered during the computation of the
* partial degree.
*
* @throws unspecified any exception thrown by:
* - threading primitives,
* - piranha::safe_cast(),
* - the constructor of the degree type,
* - memory allocation errors in standard containers.
*/
template <typename U, typename T = polynomial, at_degree_set_enabler<T, U> = 0>
static void set_auto_truncate_degree(const U &max_degree, const symbol_fset &names)
{
// Copy+move for exception safety.
auto new_degree = piranha::safe_cast<degree_type<T>>(max_degree);
auto new_names = names;
auto &at_dm = get_at_degree_max();
std::lock_guard<std::mutex> lock(s_at_degree_mutex);
truncation_clear_pow_cache(2, new_degree, new_names);
s_at_degree_mode = 2;
at_dm = std::move(new_degree);
s_at_degree_names = std::move(new_names);
}
/// Disable degree-based auto-truncation.
/**
* \note
* This method is available only if the requisites outlined in piranha::polynomial are satisfied.
*
* Disable the degree-based auto-truncation mechanism.
*
* @throws unspecified any exception thrown by:
* - threading primitives,
* - the constructor of the degree type,
* - memory allocation errors in standard containers.
*/
template <typename T = polynomial, at_degree_enabler<T> = 0>
static void unset_auto_truncate_degree()
{
degree_type<T> new_degree(0);
auto &at_dm = get_at_degree_max();
std::lock_guard<std::mutex> lock(s_at_degree_mutex);
s_at_degree_mode = 0;
at_dm = std::move(new_degree);
s_at_degree_names.clear();
}
/// Query the status of the degree-based auto-truncation mechanism.
/**
* \note
* This method is available only if the requisites outlined in piranha::polynomial are satisfied.
*
* This method will return a tuple of three elements describing the status of the degree-based auto-truncation
* mechanism.
* The elements of the tuple have the following meaning:
* - truncation mode (0 if disabled, 1 for total-degree truncation and 2 for partial-degree truncation),
* - the maximum degree allowed,
* - the list of names to be considered for partial truncation.
*
* @return a tuple representing the status of the degree-based auto-truncation mechanism.
*
* @throws unspecified any exception thrown by threading primitives or by the involved constructors.
*/
template <typename T = polynomial, at_degree_enabler<T> = 0>
static std::tuple<int, degree_type<T>, symbol_fset> get_auto_truncate_degree()
{
std::lock_guard<std::mutex> lock(s_at_degree_mutex);
return std::make_tuple(s_at_degree_mode, get_at_degree_max(), s_at_degree_names);
}
/// Find coefficient.
/**
* \note
* This method is enabled only if:
* - \p T satisfies piranha::is_input_range,
* - \p Key can be constructed from the begin/end iterators of \p c and a piranha::symbol_fset.
*
* This method will first construct a term with zero coefficient and key initialised from the begin/end iterators
* of \p c and the symbol set of \p this, and it will then try to locate the term inside \p this.
* If the term is found, its coefficient will be returned. Otherwise, a coefficient initialised
* from 0 will be returned.
*
* @param c the container that will be used to construct the \p Key to be located.
*
* @returns the coefficient of the term whose \p Key corresponds to \p c if such term exists,
* zero otherwise.
*
* @throws unspecified any exception thrown by:
* - term, coefficient and key construction,
* - piranha::hash_set::find().
*/
template <typename T, find_cf_enabler<T> = 0>
Cf find_cf(T &&c) const
{
using std::begin;
using std::end;
return find_cf_impl(begin(std::forward<T>(c)), end(std::forward<T>(c)));
}
/// Find coefficient.
/**
* \note
* This method is enabled only if \p Key can be constructed from the begin/end iterators of \p l and a
* piranha::symbol_fset.
*
* This method is identical to the other overload with the same name, and it is provided for convenience.
*
* @param l the list that will be used to construct the \p Key to be located.
*
* @returns the coefficient of the term whose \p Key corresponds to \p l if such term exists,
* zero otherwise.
*
* @throws unspecified any exception thrown by the other overload.
*/
template <typename T, find_cf_init_list_enabler<T> = 0>
Cf find_cf(std::initializer_list<T> l) const
{
using std::begin;
using std::end;
return find_cf_impl(begin(l), end(l));
}
/// Untruncated multiplication.
/**
* \note
* This function template is enabled only if the calling piranha::polynomial satisfies piranha::is_multipliable,
* returning the calling piranha::polynomial as return type.
*
* This function will return the product of \p p1 and \p p2, computed without truncation (regardless
* of the current automatic truncation settings). Note that this function is
* available only if the operands are of the same type and no type promotions affect the coefficient types
* during multiplication.
*
* @param p1 the first operand.
* @param p2 the second operand.
*
* @return the product of \p p1 and \p p2.
*
* @throws unspecified any exception thrown by:
* - the public interface of the specialisation of piranha::series_multiplier for piranha::polynomial,
* - the public interface of piranha::symbol_fset,
* - the public interface of piranha::series.
*/
template <typename T = polynomial, um_enabler<T> = 0>
static polynomial untruncated_multiplication(const polynomial &p1, const polynomial &p2)
{
auto runner = [](const polynomial &a, const polynomial &b) {
return series_multiplier<polynomial>(a, b)._untruncated_multiplication();
};
return um_tm_implementation(p1, p2, runner);
}
/// Truncated multiplication (total degree).
/**
* \note
* This function template is enabled only if the following conditions hold:
* - the calling piranha::polynomial satisfies piranha::is_multipliable, returning the calling piranha::polynomial
* as return type,
* - the requirements for truncated multiplication outlined in piranha::polynomial are satisfied,
* - \p U can be safely cast to the degree type of the calling piranha::polynomial.
*
* This function will return the product of \p p1 and \p p2, truncated to the maximum total degree
* of \p max_degree (regardless of the current automatic truncation settings).
* Note that this function is
* available only if the operands are of the same type and no type promotions affect the coefficient types
* during multiplication.
*
* @param p1 the first operand.
* @param p2 the second operand.
* @param max_degree the maximum total degree in the result.
*
* @return the truncated product of \p p1 and \p p2.
*
* @throws unspecified any exception thrown by:
* - the public interface of the specialisation of piranha::series_multiplier for piranha::polynomial,
* - the public interface of piranha::symbol_fset,
* - the public interface of piranha::series,
* - piranha::safe_cast().
*/
template <typename U, typename T = polynomial, tm_enabler<T, U> = 0>
static polynomial truncated_multiplication(const polynomial &p1, const polynomial &p2, const U &max_degree)
{
// NOTE: these 2 implementations may be rolled into one once we can safely capture variadic arguments
// in lambdas.
auto runner = [&max_degree](const polynomial &a, const polynomial &b) {
return series_multiplier<polynomial>(a, b)._truncated_multiplication(
piranha::safe_cast<degree_type<T>>(max_degree));
};
return um_tm_implementation(p1, p2, runner);
}
/// Truncated multiplication (partial degree).
/**
* \note
* This function template is enabled only if the following conditions hold:
* - the calling piranha::polynomial satisfies piranha::is_multipliable, returning the calling piranha::polynomial
* as return type,
* - the requirements for truncated multiplication outlined in piranha::polynomial are satisfied,
* - \p U can be safely cast to the degree type of the calling piranha::polynomial.
*
* This function will return the product of \p p1 and \p p2, truncated to the maximum partial degree
* of \p max_degree (regardless of the current automatic truncation settings). Note that this function is
* available only if the operands are of the same type and no type promotions affect the coefficient types
* during multiplication.
*
* @param p1 the first operand.
* @param p2 the second operand.
* @param max_degree the maximum degree in the result.
* @param names the set of the symbols that will be considered in the computation of the degree.
*
* @return the truncated product of \p p1 and \p p2.
*
* @throws unspecified any exception thrown by:
* - the public interface of the specialisation of piranha::series_multiplier for piranha::polynomial,
* - the public interface of piranha::symbol_fset,
* - the public interface of piranha::series,
* - piranha::safe_cast().
*/
template <typename U, typename T = polynomial, tm_enabler<T, U> = 0>
static polynomial truncated_multiplication(const polynomial &p1, const polynomial &p2, const U &max_degree,
const symbol_fset &names)
{
// NOTE: total and partial degree must be the same.
auto runner = [&max_degree, &names](const polynomial &a, const polynomial &b) -> polynomial {
const auto idx = ss_intersect_idx(a.get_symbol_set(), names);
return series_multiplier<polynomial>(a, b)._truncated_multiplication(
piranha::safe_cast<degree_type<T>>(max_degree), names, idx);
};
return um_tm_implementation(p1, p2, runner);
}
private:
// Static data for auto_truncate_degree.
static std::mutex s_at_degree_mutex;
static int s_at_degree_mode;
static symbol_fset s_at_degree_names;
};
// Static inits.
template <typename Cf, typename Key>
std::mutex polynomial<Cf, Key>::s_at_degree_mutex;
template <typename Cf, typename Key>
int polynomial<Cf, Key>::s_at_degree_mode = 0;
template <typename Cf, typename Key>
symbol_fset polynomial<Cf, Key>::s_at_degree_names;
namespace detail
{
// Identification of key types for dispatching in the multiplier.
template <typename T>
struct is_kronecker_monomial {
static const bool value = false;
};
template <typename T>
struct is_kronecker_monomial<kronecker_monomial<T>> {
static const bool value = true;
};
template <typename T>
struct is_monomial {
static const bool value = false;
};
template <typename T, typename S>
struct is_monomial<monomial<T, S>> {
static const bool value = true;
};
// Identify the presence of auto-truncation methods in the poly multiplier.
template <typename S, typename T>
class has_set_auto_truncate_degree : sfinae_types
{
// NOTE: if we have total degree auto truncation, we also have partial degree truncation.
template <typename S1, typename T1>
static auto test(const S1 &, const T1 &t) -> decltype(S1::set_auto_truncate_degree(t), void(), yes());
static no test(...);
public:
static const bool value = std::is_same<yes, decltype(test(std::declval<S>(), std::declval<T>()))>::value;
};
template <typename S, typename T>
const bool has_set_auto_truncate_degree<S, T>::value;
template <typename S>
class has_get_auto_truncate_degree : sfinae_types
{
template <typename S1>
static auto test(const S1 &) -> decltype(S1::get_auto_truncate_degree(), void(), yes());
static no test(...);
public:
static const bool value = std::is_same<yes, decltype(test(std::declval<S>()))>::value;
};
template <typename S>
const bool has_get_auto_truncate_degree<S>::value;
// Global enabler for the polynomial multiplier.
template <typename Series>
using poly_multiplier_enabler = typename std::enable_if<std::is_base_of<detail::polynomial_tag, Series>::value>::type;
}
/// Specialisation of piranha::series_multiplier for piranha::polynomial.
/**
* This specialisation of piranha::series_multiplier is enabled when \p Series is an instance of
* piranha::polynomial.
*
* ## Type requirements ##
*
* \p Series must be suitable for use in piranha::base_series_multiplier.
*
* ## Exception safety guarantee ##
*
* This class provides the same guarantee as piranha::base_series_multiplier.
*
* ## Move semantics ##
*
* Move semantics is equivalent to piranha::base_series_multiplier's move semantics.
*/
template <typename Series>
class series_multiplier<Series, detail::poly_multiplier_enabler<Series>> : public base_series_multiplier<Series>
{
// Base multiplier type.
using base = base_series_multiplier<Series>;
// Cf type getter shortcut.
template <typename T>
using cf_t = typename T::term_type::cf_type;
// Key type getter shortcut.
template <typename T>