diff --git a/dev/_downloads/0130acc9674ca6615e762dac32f6f525/matrices-10.pdf b/dev/_downloads/0130acc9674ca6615e762dac32f6f525/matrices-10.pdf index 24cd7235f04..74856cb96f6 100644 Binary files a/dev/_downloads/0130acc9674ca6615e762dac32f6f525/matrices-10.pdf and b/dev/_downloads/0130acc9674ca6615e762dac32f6f525/matrices-10.pdf differ diff --git a/dev/_downloads/0249fb66c2fcb06b78bd6a84135be88a/beam-2.pdf b/dev/_downloads/0249fb66c2fcb06b78bd6a84135be88a/beam-2.pdf index 989ac2d388e..7e69c8287fa 100644 Binary files a/dev/_downloads/0249fb66c2fcb06b78bd6a84135be88a/beam-2.pdf and b/dev/_downloads/0249fb66c2fcb06b78bd6a84135be88a/beam-2.pdf differ diff --git a/dev/_downloads/02f5470280a542a7c80635a082cb7e09/beam-23.pdf b/dev/_downloads/02f5470280a542a7c80635a082cb7e09/beam-23.pdf index debefb75956..47a700b024e 100644 Binary files a/dev/_downloads/02f5470280a542a7c80635a082cb7e09/beam-23.pdf and b/dev/_downloads/02f5470280a542a7c80635a082cb7e09/beam-23.pdf differ diff --git a/dev/_downloads/034c3ce6c53eca7932c83f9b35d14c64/plotting-2.pdf b/dev/_downloads/034c3ce6c53eca7932c83f9b35d14c64/plotting-2.pdf index f83688b7973..9d6ca53b18c 100644 Binary files a/dev/_downloads/034c3ce6c53eca7932c83f9b35d14c64/plotting-2.pdf and b/dev/_downloads/034c3ce6c53eca7932c83f9b35d14c64/plotting-2.pdf differ diff --git a/dev/_downloads/0616d85a2c2e5a070fd791bdcdb1e35e/plotting-32_01.pdf b/dev/_downloads/0616d85a2c2e5a070fd791bdcdb1e35e/plotting-32_01.pdf index 5d126cddaa6..8ae9eb1ed5a 100644 Binary files a/dev/_downloads/0616d85a2c2e5a070fd791bdcdb1e35e/plotting-32_01.pdf and b/dev/_downloads/0616d85a2c2e5a070fd791bdcdb1e35e/plotting-32_01.pdf differ diff --git a/dev/_downloads/0680199b4e61bc189fceb4418aa72812/control_plots-4.pdf b/dev/_downloads/0680199b4e61bc189fceb4418aa72812/control_plots-4.pdf index 198ef0eab9e..ad5e623b743 100644 Binary files a/dev/_downloads/0680199b4e61bc189fceb4418aa72812/control_plots-4.pdf and b/dev/_downloads/0680199b4e61bc189fceb4418aa72812/control_plots-4.pdf differ diff --git a/dev/_downloads/077b659bec1d5c2fd531dbd0f7e15f0f/beam_problems-13_00.pdf b/dev/_downloads/077b659bec1d5c2fd531dbd0f7e15f0f/beam_problems-13_00.pdf index 206d4c3928f..a917730654b 100644 Binary files a/dev/_downloads/077b659bec1d5c2fd531dbd0f7e15f0f/beam_problems-13_00.pdf and b/dev/_downloads/077b659bec1d5c2fd531dbd0f7e15f0f/beam_problems-13_00.pdf differ diff --git a/dev/_downloads/0a5b397c3adc07987864b0441654dc1c/beam-1.pdf b/dev/_downloads/0a5b397c3adc07987864b0441654dc1c/beam-1.pdf index 927b3a13ad1..e38aecc4257 100644 Binary files a/dev/_downloads/0a5b397c3adc07987864b0441654dc1c/beam-1.pdf and b/dev/_downloads/0a5b397c3adc07987864b0441654dc1c/beam-1.pdf differ diff --git a/dev/_downloads/0c7c1262b6b611b1944eed12f33413fe/beam-5.pdf b/dev/_downloads/0c7c1262b6b611b1944eed12f33413fe/beam-5.pdf index 131ad81e183..91edd80d3e4 100644 Binary files a/dev/_downloads/0c7c1262b6b611b1944eed12f33413fe/beam-5.pdf and b/dev/_downloads/0c7c1262b6b611b1944eed12f33413fe/beam-5.pdf differ diff --git a/dev/_downloads/0eb265c8614c7bd3f16f6034d076f6d3/beam-21.pdf b/dev/_downloads/0eb265c8614c7bd3f16f6034d076f6d3/beam-21.pdf index f6787fad1bb..8210bb2101f 100644 Binary files a/dev/_downloads/0eb265c8614c7bd3f16f6034d076f6d3/beam-21.pdf and b/dev/_downloads/0eb265c8614c7bd3f16f6034d076f6d3/beam-21.pdf differ diff --git a/dev/_downloads/0efc8f797e345bcc903c8f4dab4a5322/plotting-4.pdf b/dev/_downloads/0efc8f797e345bcc903c8f4dab4a5322/plotting-4.pdf index 75c80fd195f..2becae48b09 100644 Binary files a/dev/_downloads/0efc8f797e345bcc903c8f4dab4a5322/plotting-4.pdf and b/dev/_downloads/0efc8f797e345bcc903c8f4dab4a5322/plotting-4.pdf differ diff --git a/dev/_downloads/0ffd2a0f4570e502b64ad8529258801f/plotting-17.pdf b/dev/_downloads/0ffd2a0f4570e502b64ad8529258801f/plotting-17.pdf index d0a3be30eb5..b6e51d3abd0 100644 Binary files a/dev/_downloads/0ffd2a0f4570e502b64ad8529258801f/plotting-17.pdf and b/dev/_downloads/0ffd2a0f4570e502b64ad8529258801f/plotting-17.pdf differ diff --git a/dev/_downloads/1362531cda049d5b7f4db4abe11d4178/plotting-6.pdf b/dev/_downloads/1362531cda049d5b7f4db4abe11d4178/plotting-6.pdf index bb6f8e62739..18d6e93d5d2 100644 Binary files a/dev/_downloads/1362531cda049d5b7f4db4abe11d4178/plotting-6.pdf and b/dev/_downloads/1362531cda049d5b7f4db4abe11d4178/plotting-6.pdf differ diff --git a/dev/_downloads/14bd882358332276f28c2e3ace8343d5/control_plots-5.pdf b/dev/_downloads/14bd882358332276f28c2e3ace8343d5/control_plots-5.pdf index f46e3d69901..e62cff4ead4 100644 Binary files a/dev/_downloads/14bd882358332276f28c2e3ace8343d5/control_plots-5.pdf and b/dev/_downloads/14bd882358332276f28c2e3ace8343d5/control_plots-5.pdf differ diff --git a/dev/_downloads/16c046e4f150f3aca5fb6bd438b952ce/matrices-24.pdf b/dev/_downloads/16c046e4f150f3aca5fb6bd438b952ce/matrices-24.pdf index 7ce0bd32cca..710fc639b05 100644 Binary files a/dev/_downloads/16c046e4f150f3aca5fb6bd438b952ce/matrices-24.pdf and b/dev/_downloads/16c046e4f150f3aca5fb6bd438b952ce/matrices-24.pdf differ diff --git a/dev/_downloads/16f8dba9abaa041f16c4636d6e41a0ac/matrices-25.pdf b/dev/_downloads/16f8dba9abaa041f16c4636d6e41a0ac/matrices-25.pdf index f363351d5d5..5aad70d20d3 100644 Binary files a/dev/_downloads/16f8dba9abaa041f16c4636d6e41a0ac/matrices-25.pdf and b/dev/_downloads/16f8dba9abaa041f16c4636d6e41a0ac/matrices-25.pdf differ diff --git a/dev/_downloads/1a31ae7f3ddd6165062befbddb76e6ca/generate_plots_q3_3.pdf b/dev/_downloads/1a31ae7f3ddd6165062befbddb76e6ca/generate_plots_q3_3.pdf index d5fc802549b..05e1fbf467d 100644 Binary files a/dev/_downloads/1a31ae7f3ddd6165062befbddb76e6ca/generate_plots_q3_3.pdf and b/dev/_downloads/1a31ae7f3ddd6165062befbddb76e6ca/generate_plots_q3_3.pdf differ diff --git a/dev/_downloads/1f24a27fa4a24f0b331e9442f61363d7/plotting-16.pdf b/dev/_downloads/1f24a27fa4a24f0b331e9442f61363d7/plotting-16.pdf index 609990fd29f..18cb0819bbf 100644 Binary files a/dev/_downloads/1f24a27fa4a24f0b331e9442f61363d7/plotting-16.pdf and b/dev/_downloads/1f24a27fa4a24f0b331e9442f61363d7/plotting-16.pdf differ diff --git a/dev/_downloads/2019cb6b524d1d6351bac9c894de42dd/plotting-26.hires.png b/dev/_downloads/2019cb6b524d1d6351bac9c894de42dd/plotting-26.hires.png index 6c58f69d115..5eec0f19382 100644 Binary files a/dev/_downloads/2019cb6b524d1d6351bac9c894de42dd/plotting-26.hires.png and b/dev/_downloads/2019cb6b524d1d6351bac9c894de42dd/plotting-26.hires.png differ diff --git a/dev/_downloads/2082eb4d6b0c42668444836c10a5a149/beam_problems-14.pdf b/dev/_downloads/2082eb4d6b0c42668444836c10a5a149/beam_problems-14.pdf index 2bff820ff50..ead748661a1 100644 Binary files a/dev/_downloads/2082eb4d6b0c42668444836c10a5a149/beam_problems-14.pdf and b/dev/_downloads/2082eb4d6b0c42668444836c10a5a149/beam_problems-14.pdf differ diff --git a/dev/_downloads/2454d35ad3fc284cb67b6c619b4246c1/beam-8.pdf b/dev/_downloads/2454d35ad3fc284cb67b6c619b4246c1/beam-8.pdf index 7b55c72ff1b..33031822701 100644 Binary files a/dev/_downloads/2454d35ad3fc284cb67b6c619b4246c1/beam-8.pdf and b/dev/_downloads/2454d35ad3fc284cb67b6c619b4246c1/beam-8.pdf differ diff --git a/dev/_downloads/25cb4bfd257025a59c1c236b698c1d17/generate_plots_q3_5_2.pdf b/dev/_downloads/25cb4bfd257025a59c1c236b698c1d17/generate_plots_q3_5_2.pdf index 2aae602e2d6..c610e07e097 100644 Binary files a/dev/_downloads/25cb4bfd257025a59c1c236b698c1d17/generate_plots_q3_5_2.pdf and b/dev/_downloads/25cb4bfd257025a59c1c236b698c1d17/generate_plots_q3_5_2.pdf differ diff --git a/dev/_downloads/2608cc95ac952e335ca0ce8cea458c1b/matrices-22.pdf b/dev/_downloads/2608cc95ac952e335ca0ce8cea458c1b/matrices-22.pdf index dff2a049409..fd47108c063 100644 Binary files a/dev/_downloads/2608cc95ac952e335ca0ce8cea458c1b/matrices-22.pdf and b/dev/_downloads/2608cc95ac952e335ca0ce8cea458c1b/matrices-22.pdf differ diff --git a/dev/_downloads/2667a5fcc739d282a7512f6b7b39071a/matrices-4.pdf b/dev/_downloads/2667a5fcc739d282a7512f6b7b39071a/matrices-4.pdf index 09b6767b67c..3d880b3f8cf 100644 Binary files a/dev/_downloads/2667a5fcc739d282a7512f6b7b39071a/matrices-4.pdf and b/dev/_downloads/2667a5fcc739d282a7512f6b7b39071a/matrices-4.pdf differ diff --git a/dev/_downloads/26aeb23613c82467dc9ad9bdc328ab32/plotting-32_00.pdf b/dev/_downloads/26aeb23613c82467dc9ad9bdc328ab32/plotting-32_00.pdf index 4f4810ba318..95d110e3ffa 100644 Binary files a/dev/_downloads/26aeb23613c82467dc9ad9bdc328ab32/plotting-32_00.pdf and b/dev/_downloads/26aeb23613c82467dc9ad9bdc328ab32/plotting-32_00.pdf differ diff --git a/dev/_downloads/295bb235d3caa42841a5fbfa905580df/beam_problems-18.pdf b/dev/_downloads/295bb235d3caa42841a5fbfa905580df/beam_problems-18.pdf index 51e8ad152ce..c9a51c97b1f 100644 Binary files a/dev/_downloads/295bb235d3caa42841a5fbfa905580df/beam_problems-18.pdf and b/dev/_downloads/295bb235d3caa42841a5fbfa905580df/beam_problems-18.pdf differ diff --git a/dev/_downloads/2acde0fab574588f4a28670019a75bf9/plotting-26.pdf b/dev/_downloads/2acde0fab574588f4a28670019a75bf9/plotting-26.pdf index 760050bc18d..9dcc8a86121 100644 Binary files a/dev/_downloads/2acde0fab574588f4a28670019a75bf9/plotting-26.pdf and b/dev/_downloads/2acde0fab574588f4a28670019a75bf9/plotting-26.pdf differ diff --git a/dev/_downloads/2f44ee19ebd4c314ad1c408629357c53/plotting-1.pdf b/dev/_downloads/2f44ee19ebd4c314ad1c408629357c53/plotting-1.pdf index 9a34ac82f91..8b51c6b5603 100644 Binary files a/dev/_downloads/2f44ee19ebd4c314ad1c408629357c53/plotting-1.pdf and b/dev/_downloads/2f44ee19ebd4c314ad1c408629357c53/plotting-1.pdf differ diff --git a/dev/_downloads/2fe7ddde63c7b986288bcf42780219f7/plotting-29.hires.png b/dev/_downloads/2fe7ddde63c7b986288bcf42780219f7/plotting-29.hires.png index 8ed835705a8..c530c58e074 100644 Binary files a/dev/_downloads/2fe7ddde63c7b986288bcf42780219f7/plotting-29.hires.png and b/dev/_downloads/2fe7ddde63c7b986288bcf42780219f7/plotting-29.hires.png differ diff --git a/dev/_downloads/3319e145d33fb7c15b85dd93189e26e2/control_plots-2.pdf b/dev/_downloads/3319e145d33fb7c15b85dd93189e26e2/control_plots-2.pdf index d8fcf63c754..663f661685b 100644 Binary files a/dev/_downloads/3319e145d33fb7c15b85dd93189e26e2/control_plots-2.pdf and b/dev/_downloads/3319e145d33fb7c15b85dd93189e26e2/control_plots-2.pdf differ diff --git a/dev/_downloads/33391c644ccb248b4c17deb758dc2301/control_plots-1.pdf b/dev/_downloads/33391c644ccb248b4c17deb758dc2301/control_plots-1.pdf index 00de2328799..a60a5dfb4ce 100644 Binary files a/dev/_downloads/33391c644ccb248b4c17deb758dc2301/control_plots-1.pdf and b/dev/_downloads/33391c644ccb248b4c17deb758dc2301/control_plots-1.pdf differ diff --git a/dev/_downloads/39dc203c3bf6e7485368c7a401448a6f/matrices-8.pdf b/dev/_downloads/39dc203c3bf6e7485368c7a401448a6f/matrices-8.pdf index 80012f10ad8..d44699646af 100644 Binary files a/dev/_downloads/39dc203c3bf6e7485368c7a401448a6f/matrices-8.pdf and b/dev/_downloads/39dc203c3bf6e7485368c7a401448a6f/matrices-8.pdf differ diff --git a/dev/_downloads/3af3ee18448b7a687ef6594665f932f9/plotting-19.pdf b/dev/_downloads/3af3ee18448b7a687ef6594665f932f9/plotting-19.pdf index 7e78b1fb083..d911005a06e 100644 Binary files a/dev/_downloads/3af3ee18448b7a687ef6594665f932f9/plotting-19.pdf and b/dev/_downloads/3af3ee18448b7a687ef6594665f932f9/plotting-19.pdf differ diff --git a/dev/_downloads/3cd14c510b41514f1496a3155ea8cf2d/matrices-17.pdf b/dev/_downloads/3cd14c510b41514f1496a3155ea8cf2d/matrices-17.pdf index beda69ec785..106627b15a3 100644 Binary files a/dev/_downloads/3cd14c510b41514f1496a3155ea8cf2d/matrices-17.pdf and b/dev/_downloads/3cd14c510b41514f1496a3155ea8cf2d/matrices-17.pdf differ diff --git a/dev/_downloads/464f047ba3ef7f04429a4eb163a6a2de/matrices-18.pdf b/dev/_downloads/464f047ba3ef7f04429a4eb163a6a2de/matrices-18.pdf index 9a23394843b..477afc30570 100644 Binary files a/dev/_downloads/464f047ba3ef7f04429a4eb163a6a2de/matrices-18.pdf and b/dev/_downloads/464f047ba3ef7f04429a4eb163a6a2de/matrices-18.pdf differ diff --git a/dev/_downloads/4c9cbd846f69df68795ea4e2cdf667e9/plotting-33.pdf b/dev/_downloads/4c9cbd846f69df68795ea4e2cdf667e9/plotting-33.pdf index e121ad83a35..6066dfec28d 100644 Binary files a/dev/_downloads/4c9cbd846f69df68795ea4e2cdf667e9/plotting-33.pdf and b/dev/_downloads/4c9cbd846f69df68795ea4e2cdf667e9/plotting-33.pdf differ diff --git a/dev/_downloads/4d0c9c96647fc2441757598f44d4936b/beam-20.pdf b/dev/_downloads/4d0c9c96647fc2441757598f44d4936b/beam-20.pdf index faa20b2c452..dafb23d7b65 100644 Binary files a/dev/_downloads/4d0c9c96647fc2441757598f44d4936b/beam-20.pdf and b/dev/_downloads/4d0c9c96647fc2441757598f44d4936b/beam-20.pdf differ diff --git a/dev/_downloads/4f691d69f2e82384c2ceae9f2ca04cdc/generate_plots_q3_4.pdf b/dev/_downloads/4f691d69f2e82384c2ceae9f2ca04cdc/generate_plots_q3_4.pdf index b4ebc891975..908e546ecfc 100644 Binary files a/dev/_downloads/4f691d69f2e82384c2ceae9f2ca04cdc/generate_plots_q3_4.pdf and b/dev/_downloads/4f691d69f2e82384c2ceae9f2ca04cdc/generate_plots_q3_4.pdf differ diff --git a/dev/_downloads/4f8a4d280007c46440ecb7e279e1d3cb/plotting-25.hires.png b/dev/_downloads/4f8a4d280007c46440ecb7e279e1d3cb/plotting-25.hires.png index 2c81e9a0949..865b4daa27a 100644 Binary files a/dev/_downloads/4f8a4d280007c46440ecb7e279e1d3cb/plotting-25.hires.png and b/dev/_downloads/4f8a4d280007c46440ecb7e279e1d3cb/plotting-25.hires.png differ diff --git a/dev/_downloads/5271bad998891ddd195bf7ea0e44d844/biomechanics-11.pdf b/dev/_downloads/5271bad998891ddd195bf7ea0e44d844/biomechanics-11.pdf index e482b97b47a..b9c57eea84b 100644 Binary files a/dev/_downloads/5271bad998891ddd195bf7ea0e44d844/biomechanics-11.pdf and b/dev/_downloads/5271bad998891ddd195bf7ea0e44d844/biomechanics-11.pdf differ diff --git a/dev/_downloads/53f951a6065782035628167d02f26410/biomechanical-model-example-35.pdf b/dev/_downloads/53f951a6065782035628167d02f26410/biomechanical-model-example-35.pdf index b50c3bd16f0..6b50bb458e0 100644 Binary files a/dev/_downloads/53f951a6065782035628167d02f26410/biomechanical-model-example-35.pdf and b/dev/_downloads/53f951a6065782035628167d02f26410/biomechanical-model-example-35.pdf differ diff --git a/dev/_downloads/56227f1745cb31fcd75cdc19f5cad645/beam_problems-13_01.pdf b/dev/_downloads/56227f1745cb31fcd75cdc19f5cad645/beam_problems-13_01.pdf index 6b0d406efe8..ec3636617b5 100644 Binary files a/dev/_downloads/56227f1745cb31fcd75cdc19f5cad645/beam_problems-13_01.pdf and b/dev/_downloads/56227f1745cb31fcd75cdc19f5cad645/beam_problems-13_01.pdf differ diff --git a/dev/_downloads/56447441b8d8108229134a5d3454516c/plotting-7.pdf b/dev/_downloads/56447441b8d8108229134a5d3454516c/plotting-7.pdf index 45c14f69d31..04de3dd478d 100644 Binary files a/dev/_downloads/56447441b8d8108229134a5d3454516c/plotting-7.pdf and b/dev/_downloads/56447441b8d8108229134a5d3454516c/plotting-7.pdf differ diff --git a/dev/_downloads/569497501b2d3eb864ce466d19b06017/plotting-20.pdf b/dev/_downloads/569497501b2d3eb864ce466d19b06017/plotting-20.pdf index 0e3e0554b25..40d0eb6db3e 100644 Binary files a/dev/_downloads/569497501b2d3eb864ce466d19b06017/plotting-20.pdf and b/dev/_downloads/569497501b2d3eb864ce466d19b06017/plotting-20.pdf differ diff --git a/dev/_downloads/5815ed289d6d66d90e420fd31330fef7/plotting-28.pdf b/dev/_downloads/5815ed289d6d66d90e420fd31330fef7/plotting-28.pdf index d5fd5d58b2a..2e4ce02ce26 100644 Binary files a/dev/_downloads/5815ed289d6d66d90e420fd31330fef7/plotting-28.pdf and b/dev/_downloads/5815ed289d6d66d90e420fd31330fef7/plotting-28.pdf differ diff --git a/dev/_downloads/5860560b08ead850923e530e3240b5c6/plotting-15.pdf b/dev/_downloads/5860560b08ead850923e530e3240b5c6/plotting-15.pdf index 4497d7ae328..6c917847a33 100644 Binary files a/dev/_downloads/5860560b08ead850923e530e3240b5c6/plotting-15.pdf and b/dev/_downloads/5860560b08ead850923e530e3240b5c6/plotting-15.pdf differ diff --git a/dev/_downloads/5b83bd080155a6f59e2eeb633bda5ab4/matrices-13.pdf b/dev/_downloads/5b83bd080155a6f59e2eeb633bda5ab4/matrices-13.pdf index d4cec3316a2..cc7286c28b1 100644 Binary files a/dev/_downloads/5b83bd080155a6f59e2eeb633bda5ab4/matrices-13.pdf and b/dev/_downloads/5b83bd080155a6f59e2eeb633bda5ab4/matrices-13.pdf differ diff --git a/dev/_downloads/6236456dc31640e622c3f943842d9925/plotting-27.pdf b/dev/_downloads/6236456dc31640e622c3f943842d9925/plotting-27.pdf index ee90486e864..a90a388cfdb 100644 Binary files a/dev/_downloads/6236456dc31640e622c3f943842d9925/plotting-27.pdf and b/dev/_downloads/6236456dc31640e622c3f943842d9925/plotting-27.pdf differ diff --git a/dev/_downloads/68597f1bcbf2528fdc041a5c14e53f0f/plotting-30.png b/dev/_downloads/68597f1bcbf2528fdc041a5c14e53f0f/plotting-30.png index 7d6a513f665..6827f3c01da 100644 Binary files a/dev/_downloads/68597f1bcbf2528fdc041a5c14e53f0f/plotting-30.png and b/dev/_downloads/68597f1bcbf2528fdc041a5c14e53f0f/plotting-30.png differ diff --git a/dev/_downloads/68bf3baa5f6498f8399b26d3d85ce17a/biomechanics-12.pdf b/dev/_downloads/68bf3baa5f6498f8399b26d3d85ce17a/biomechanics-12.pdf index 1b6df17636d..dd1d70e8afb 100644 Binary files a/dev/_downloads/68bf3baa5f6498f8399b26d3d85ce17a/biomechanics-12.pdf and b/dev/_downloads/68bf3baa5f6498f8399b26d3d85ce17a/biomechanics-12.pdf differ diff --git a/dev/_downloads/704bfe351153d402a4a0a831ece25675/matrices-2.pdf b/dev/_downloads/704bfe351153d402a4a0a831ece25675/matrices-2.pdf index bebeade6bdf..af41bc10ff0 100644 Binary files a/dev/_downloads/704bfe351153d402a4a0a831ece25675/matrices-2.pdf and b/dev/_downloads/704bfe351153d402a4a0a831ece25675/matrices-2.pdf differ diff --git a/dev/_downloads/76c597139b65debdf0e125c15cd040ca/plotting-25.png b/dev/_downloads/76c597139b65debdf0e125c15cd040ca/plotting-25.png index 6def3325cc2..c8beac16141 100644 Binary files a/dev/_downloads/76c597139b65debdf0e125c15cd040ca/plotting-25.png and b/dev/_downloads/76c597139b65debdf0e125c15cd040ca/plotting-25.png differ diff --git a/dev/_downloads/78092bdffcba955dd374da738fd5c1d2/control_plots-6.png b/dev/_downloads/78092bdffcba955dd374da738fd5c1d2/control_plots-6.png index e9e03ceb26f..f26fdfb5cea 100644 Binary files a/dev/_downloads/78092bdffcba955dd374da738fd5c1d2/control_plots-6.png and b/dev/_downloads/78092bdffcba955dd374da738fd5c1d2/control_plots-6.png differ diff --git a/dev/_downloads/7bfa6a992ea402720a120fd5093741a4/plotting-11.pdf b/dev/_downloads/7bfa6a992ea402720a120fd5093741a4/plotting-11.pdf index a151db526c2..9d63dc49c1e 100644 Binary files a/dev/_downloads/7bfa6a992ea402720a120fd5093741a4/plotting-11.pdf and b/dev/_downloads/7bfa6a992ea402720a120fd5093741a4/plotting-11.pdf differ diff --git a/dev/_downloads/7d4a2d083d96719b05ab2f759c57874a/matrices-6.pdf b/dev/_downloads/7d4a2d083d96719b05ab2f759c57874a/matrices-6.pdf index f5452d3e8f5..a2eda2ec5a6 100644 Binary files a/dev/_downloads/7d4a2d083d96719b05ab2f759c57874a/matrices-6.pdf and b/dev/_downloads/7d4a2d083d96719b05ab2f759c57874a/matrices-6.pdf differ diff --git a/dev/_downloads/7eed1bf07a4dacbb97d209dac2614e9a/matrices-19.pdf b/dev/_downloads/7eed1bf07a4dacbb97d209dac2614e9a/matrices-19.pdf index aa2d6772373..d2be1372739 100644 Binary files a/dev/_downloads/7eed1bf07a4dacbb97d209dac2614e9a/matrices-19.pdf and b/dev/_downloads/7eed1bf07a4dacbb97d209dac2614e9a/matrices-19.pdf differ diff --git a/dev/_downloads/80381e15163e7b0ece9149eadb09772b/control_plots-7.pdf b/dev/_downloads/80381e15163e7b0ece9149eadb09772b/control_plots-7.pdf index 12adf29d731..88e17d55704 100644 Binary files a/dev/_downloads/80381e15163e7b0ece9149eadb09772b/control_plots-7.pdf and b/dev/_downloads/80381e15163e7b0ece9149eadb09772b/control_plots-7.pdf differ diff --git a/dev/_downloads/81a43cb7598cbbe880e19146241abe5f/plotting-26.png b/dev/_downloads/81a43cb7598cbbe880e19146241abe5f/plotting-26.png index d39895362f2..f4a53ddc785 100644 Binary files a/dev/_downloads/81a43cb7598cbbe880e19146241abe5f/plotting-26.png and b/dev/_downloads/81a43cb7598cbbe880e19146241abe5f/plotting-26.png differ diff --git a/dev/_downloads/81a780d815116a5eb737d2d484c44444/matrices-21.pdf b/dev/_downloads/81a780d815116a5eb737d2d484c44444/matrices-21.pdf index 2a08607356e..74c32ab3176 100644 Binary files a/dev/_downloads/81a780d815116a5eb737d2d484c44444/matrices-21.pdf and b/dev/_downloads/81a780d815116a5eb737d2d484c44444/matrices-21.pdf differ diff --git a/dev/_downloads/81f16477713a2ebedd53f1c8ec85b754/plotting-12.pdf b/dev/_downloads/81f16477713a2ebedd53f1c8ec85b754/plotting-12.pdf index 5b01f5f5fdd..74e71b095c5 100644 Binary files a/dev/_downloads/81f16477713a2ebedd53f1c8ec85b754/plotting-12.pdf and b/dev/_downloads/81f16477713a2ebedd53f1c8ec85b754/plotting-12.pdf differ diff --git a/dev/_downloads/83ec70596dcaacc88e256e7679fafcee/matrices-12.pdf b/dev/_downloads/83ec70596dcaacc88e256e7679fafcee/matrices-12.pdf index eb4986fb503..2bbbfc6a140 100644 Binary files a/dev/_downloads/83ec70596dcaacc88e256e7679fafcee/matrices-12.pdf and b/dev/_downloads/83ec70596dcaacc88e256e7679fafcee/matrices-12.pdf differ diff --git a/dev/_downloads/865dedeca3d1430244910d89d552e5ef/beam-19.pdf b/dev/_downloads/865dedeca3d1430244910d89d552e5ef/beam-19.pdf index 936ab686017..11c2b04c2fe 100644 Binary files a/dev/_downloads/865dedeca3d1430244910d89d552e5ef/beam-19.pdf and b/dev/_downloads/865dedeca3d1430244910d89d552e5ef/beam-19.pdf differ diff --git a/dev/_downloads/88f8d6df1485ab9648408b70b7cd4c46/beam_problems-11_00.pdf b/dev/_downloads/88f8d6df1485ab9648408b70b7cd4c46/beam_problems-11_00.pdf index 2982db6a767..f8e34ae7bfd 100644 Binary files a/dev/_downloads/88f8d6df1485ab9648408b70b7cd4c46/beam_problems-11_00.pdf and b/dev/_downloads/88f8d6df1485ab9648408b70b7cd4c46/beam_problems-11_00.pdf differ diff --git a/dev/_downloads/8c3e8789c867600d80b2cce11272d81e/matrices-15.pdf b/dev/_downloads/8c3e8789c867600d80b2cce11272d81e/matrices-15.pdf index d9fc357da39..618b6009e07 100644 Binary files a/dev/_downloads/8c3e8789c867600d80b2cce11272d81e/matrices-15.pdf and b/dev/_downloads/8c3e8789c867600d80b2cce11272d81e/matrices-15.pdf differ diff --git a/dev/_downloads/8f6a7c938e347f134c67566d5aef740d/plotting-29.pdf b/dev/_downloads/8f6a7c938e347f134c67566d5aef740d/plotting-29.pdf index ca022dfb622..6d53939f538 100644 Binary files a/dev/_downloads/8f6a7c938e347f134c67566d5aef740d/plotting-29.pdf and b/dev/_downloads/8f6a7c938e347f134c67566d5aef740d/plotting-29.pdf differ diff --git a/dev/_downloads/90b2354acc779cd49f552b57929e55ab/plotting-13.pdf b/dev/_downloads/90b2354acc779cd49f552b57929e55ab/plotting-13.pdf index 33816753078..b5529f4ee48 100644 Binary files a/dev/_downloads/90b2354acc779cd49f552b57929e55ab/plotting-13.pdf and b/dev/_downloads/90b2354acc779cd49f552b57929e55ab/plotting-13.pdf differ diff --git a/dev/_downloads/912e64195566ca0058bfdb868fabd27b/beam_problems-16.pdf b/dev/_downloads/912e64195566ca0058bfdb868fabd27b/beam_problems-16.pdf index 9468da8c7ff..6117929e761 100644 Binary files a/dev/_downloads/912e64195566ca0058bfdb868fabd27b/beam_problems-16.pdf and b/dev/_downloads/912e64195566ca0058bfdb868fabd27b/beam_problems-16.pdf differ diff --git a/dev/_downloads/945e2a45816629e69cae83f93476425f/biomechanics-14.pdf b/dev/_downloads/945e2a45816629e69cae83f93476425f/biomechanics-14.pdf index c396b8a667e..c966d52d542 100644 Binary files a/dev/_downloads/945e2a45816629e69cae83f93476425f/biomechanics-14.pdf and b/dev/_downloads/945e2a45816629e69cae83f93476425f/biomechanics-14.pdf differ diff --git a/dev/_downloads/950e4c42a3beff8bac74d47e0f8d8516/plotting-24.png b/dev/_downloads/950e4c42a3beff8bac74d47e0f8d8516/plotting-24.png index 7456f578bb3..cb7af77fea4 100644 Binary files a/dev/_downloads/950e4c42a3beff8bac74d47e0f8d8516/plotting-24.png and b/dev/_downloads/950e4c42a3beff8bac74d47e0f8d8516/plotting-24.png differ diff --git a/dev/_downloads/95feb1999af91b22f624aa3ce3c6b1c4/solve-ode-1.pdf b/dev/_downloads/95feb1999af91b22f624aa3ce3c6b1c4/solve-ode-1.pdf index 2b56f500d95..95b895e2273 100644 Binary files a/dev/_downloads/95feb1999af91b22f624aa3ce3c6b1c4/solve-ode-1.pdf and b/dev/_downloads/95feb1999af91b22f624aa3ce3c6b1c4/solve-ode-1.pdf differ diff --git a/dev/_downloads/9659cd876877dfc4002fae48de3c98ae/beam-4.pdf b/dev/_downloads/9659cd876877dfc4002fae48de3c98ae/beam-4.pdf index a0f037ccbd2..1572adf6572 100644 Binary files a/dev/_downloads/9659cd876877dfc4002fae48de3c98ae/beam-4.pdf and b/dev/_downloads/9659cd876877dfc4002fae48de3c98ae/beam-4.pdf differ diff --git a/dev/_downloads/9728219edea47500a9403b3679a5bc09/plotting-10.pdf b/dev/_downloads/9728219edea47500a9403b3679a5bc09/plotting-10.pdf index 9d360c65688..260324e5183 100644 Binary files a/dev/_downloads/9728219edea47500a9403b3679a5bc09/plotting-10.pdf and b/dev/_downloads/9728219edea47500a9403b3679a5bc09/plotting-10.pdf differ diff --git a/dev/_downloads/9ae786c847d9ecd9aa665dd52ee79f4e/biomechanics-34.pdf b/dev/_downloads/9ae786c847d9ecd9aa665dd52ee79f4e/biomechanics-34.pdf index 87298aff3b7..fc29b4f3700 100644 Binary files a/dev/_downloads/9ae786c847d9ecd9aa665dd52ee79f4e/biomechanics-34.pdf and b/dev/_downloads/9ae786c847d9ecd9aa665dd52ee79f4e/biomechanics-34.pdf differ diff --git a/dev/_downloads/9ba0a373644e3b8e75cb2f2d1a46ac33/plotting-35.pdf b/dev/_downloads/9ba0a373644e3b8e75cb2f2d1a46ac33/plotting-35.pdf index 7f92921d33f..ed4bcfe8e7f 100644 Binary files a/dev/_downloads/9ba0a373644e3b8e75cb2f2d1a46ac33/plotting-35.pdf and b/dev/_downloads/9ba0a373644e3b8e75cb2f2d1a46ac33/plotting-35.pdf differ diff --git a/dev/_downloads/9ffeab016a6116f06235179bb36783a3/control_plots-6.pdf b/dev/_downloads/9ffeab016a6116f06235179bb36783a3/control_plots-6.pdf index db7d599b9d7..6ab642ac41d 100644 Binary files a/dev/_downloads/9ffeab016a6116f06235179bb36783a3/control_plots-6.pdf and b/dev/_downloads/9ffeab016a6116f06235179bb36783a3/control_plots-6.pdf differ diff --git a/dev/_downloads/a11367bb58b03bf09a75c9657b4e223a/matrices-16.pdf b/dev/_downloads/a11367bb58b03bf09a75c9657b4e223a/matrices-16.pdf index 4dba9a6529b..6d746318e6f 100644 Binary files a/dev/_downloads/a11367bb58b03bf09a75c9657b4e223a/matrices-16.pdf and b/dev/_downloads/a11367bb58b03bf09a75c9657b4e223a/matrices-16.pdf differ diff --git a/dev/_downloads/a1fd2d341cd81043a2e4702f43ad98bc/generate_plots_q3_5_1.pdf b/dev/_downloads/a1fd2d341cd81043a2e4702f43ad98bc/generate_plots_q3_5_1.pdf index 2aae602e2d6..0d3288aa9d1 100644 Binary files a/dev/_downloads/a1fd2d341cd81043a2e4702f43ad98bc/generate_plots_q3_5_1.pdf and b/dev/_downloads/a1fd2d341cd81043a2e4702f43ad98bc/generate_plots_q3_5_1.pdf differ diff --git a/dev/_downloads/a3a06dbcaf4cb9dbce7fe53c37ec22a8/plotting-30.pdf b/dev/_downloads/a3a06dbcaf4cb9dbce7fe53c37ec22a8/plotting-30.pdf index f57bf27c6d5..d7a4712a888 100644 Binary files a/dev/_downloads/a3a06dbcaf4cb9dbce7fe53c37ec22a8/plotting-30.pdf and b/dev/_downloads/a3a06dbcaf4cb9dbce7fe53c37ec22a8/plotting-30.pdf differ diff --git a/dev/_downloads/a45cb86364a3602f7138b4466beb1097/beam-3.pdf b/dev/_downloads/a45cb86364a3602f7138b4466beb1097/beam-3.pdf index b25fc178414..5bc318047a0 100644 Binary files a/dev/_downloads/a45cb86364a3602f7138b4466beb1097/beam-3.pdf and b/dev/_downloads/a45cb86364a3602f7138b4466beb1097/beam-3.pdf differ diff --git a/dev/_downloads/a6ba697f4fd41244d4a03ae13c871d77/matrices-20.pdf b/dev/_downloads/a6ba697f4fd41244d4a03ae13c871d77/matrices-20.pdf index e3162f3a880..ee9e83261a4 100644 Binary files a/dev/_downloads/a6ba697f4fd41244d4a03ae13c871d77/matrices-20.pdf and b/dev/_downloads/a6ba697f4fd41244d4a03ae13c871d77/matrices-20.pdf differ diff --git a/dev/_downloads/a892d8f10080acfce9914123b164dd0e/matrices-11.pdf b/dev/_downloads/a892d8f10080acfce9914123b164dd0e/matrices-11.pdf index 788d989f4b6..9830c3eac0f 100644 Binary files a/dev/_downloads/a892d8f10080acfce9914123b164dd0e/matrices-11.pdf and b/dev/_downloads/a892d8f10080acfce9914123b164dd0e/matrices-11.pdf differ diff --git a/dev/_downloads/aa497c934ec12bc50f842dac34beeab7/plotting-32_02.pdf b/dev/_downloads/aa497c934ec12bc50f842dac34beeab7/plotting-32_02.pdf index 6aa1ce188cc..dce797838b1 100644 Binary files a/dev/_downloads/aa497c934ec12bc50f842dac34beeab7/plotting-32_02.pdf and b/dev/_downloads/aa497c934ec12bc50f842dac34beeab7/plotting-32_02.pdf differ diff --git a/dev/_downloads/ac472fec5b32a66f329e9328277c64b3/plotting-34.pdf b/dev/_downloads/ac472fec5b32a66f329e9328277c64b3/plotting-34.pdf index 4e7b5f5efbd..615457988a5 100644 Binary files a/dev/_downloads/ac472fec5b32a66f329e9328277c64b3/plotting-34.pdf and b/dev/_downloads/ac472fec5b32a66f329e9328277c64b3/plotting-34.pdf differ diff --git a/dev/_downloads/b0f2a5ef738f9e96458a670bdb264732/beam-18.pdf b/dev/_downloads/b0f2a5ef738f9e96458a670bdb264732/beam-18.pdf index 08afc8a5ed8..34fac46377f 100644 Binary files a/dev/_downloads/b0f2a5ef738f9e96458a670bdb264732/beam-18.pdf and b/dev/_downloads/b0f2a5ef738f9e96458a670bdb264732/beam-18.pdf differ diff --git a/dev/_downloads/b78b32e3870f0d0ffa753084ae625ec7/plotting-9.pdf b/dev/_downloads/b78b32e3870f0d0ffa753084ae625ec7/plotting-9.pdf index 11fef6b57c6..cab7baf1cab 100644 Binary files a/dev/_downloads/b78b32e3870f0d0ffa753084ae625ec7/plotting-9.pdf and b/dev/_downloads/b78b32e3870f0d0ffa753084ae625ec7/plotting-9.pdf differ diff --git a/dev/_downloads/ba5808c3dcaa3ca2706d8976a3ba018c/beam_problems-11_01.pdf b/dev/_downloads/ba5808c3dcaa3ca2706d8976a3ba018c/beam_problems-11_01.pdf index 994e96e2180..4598d55cfed 100644 Binary files a/dev/_downloads/ba5808c3dcaa3ca2706d8976a3ba018c/beam_problems-11_01.pdf and b/dev/_downloads/ba5808c3dcaa3ca2706d8976a3ba018c/beam_problems-11_01.pdf differ diff --git a/dev/_downloads/be5321e199329605807b665644b38c93/biomechanical-model-example-38.pdf b/dev/_downloads/be5321e199329605807b665644b38c93/biomechanical-model-example-38.pdf index c3ef46d493a..c49fd44a806 100644 Binary files a/dev/_downloads/be5321e199329605807b665644b38c93/biomechanical-model-example-38.pdf and b/dev/_downloads/be5321e199329605807b665644b38c93/biomechanical-model-example-38.pdf differ diff --git a/dev/_downloads/c1423271668bdc35a9c394131066e255/control_plots-3.pdf b/dev/_downloads/c1423271668bdc35a9c394131066e255/control_plots-3.pdf index fb3ddc7843d..5d596635fb0 100644 Binary files a/dev/_downloads/c1423271668bdc35a9c394131066e255/control_plots-3.pdf and b/dev/_downloads/c1423271668bdc35a9c394131066e255/control_plots-3.pdf differ diff --git a/dev/_downloads/c1adee8d5f4e9aedd715240ee2abc6e5/matrices-9.pdf b/dev/_downloads/c1adee8d5f4e9aedd715240ee2abc6e5/matrices-9.pdf index 737a4266116..249fccb2119 100644 Binary files a/dev/_downloads/c1adee8d5f4e9aedd715240ee2abc6e5/matrices-9.pdf and b/dev/_downloads/c1adee8d5f4e9aedd715240ee2abc6e5/matrices-9.pdf differ diff --git a/dev/_downloads/c81702617d9f2a52fd8723b47976d6ff/generate_plots_q5.pdf b/dev/_downloads/c81702617d9f2a52fd8723b47976d6ff/generate_plots_q5.pdf index cffa59f1152..69904ba38c9 100644 Binary files a/dev/_downloads/c81702617d9f2a52fd8723b47976d6ff/generate_plots_q5.pdf and b/dev/_downloads/c81702617d9f2a52fd8723b47976d6ff/generate_plots_q5.pdf differ diff --git a/dev/_downloads/ca52fc8f0db47908fb8d38cc335d5c1a/plotting-22.pdf b/dev/_downloads/ca52fc8f0db47908fb8d38cc335d5c1a/plotting-22.pdf index b612ad24c15..f853c800492 100644 Binary files a/dev/_downloads/ca52fc8f0db47908fb8d38cc335d5c1a/plotting-22.pdf and b/dev/_downloads/ca52fc8f0db47908fb8d38cc335d5c1a/plotting-22.pdf differ diff --git a/dev/_downloads/cb44a32b25833934efb3a9d4adfe400c/plotting-29.png b/dev/_downloads/cb44a32b25833934efb3a9d4adfe400c/plotting-29.png index 3b8ce1ca09f..39f99bd0648 100644 Binary files a/dev/_downloads/cb44a32b25833934efb3a9d4adfe400c/plotting-29.png and b/dev/_downloads/cb44a32b25833934efb3a9d4adfe400c/plotting-29.png differ diff --git a/dev/_downloads/cc4619d4e67ea48ddf5026828b7569eb/beam-22.pdf b/dev/_downloads/cc4619d4e67ea48ddf5026828b7569eb/beam-22.pdf index 90ae20dcca3..961cd417bbc 100644 Binary files a/dev/_downloads/cc4619d4e67ea48ddf5026828b7569eb/beam-22.pdf and b/dev/_downloads/cc4619d4e67ea48ddf5026828b7569eb/beam-22.pdf differ diff --git a/dev/_downloads/ce89ed58fdb41bf7840cc83d6e6a1ba6/plotting-30.hires.png b/dev/_downloads/ce89ed58fdb41bf7840cc83d6e6a1ba6/plotting-30.hires.png index f2e780da9e4..77517b7364b 100644 Binary files a/dev/_downloads/ce89ed58fdb41bf7840cc83d6e6a1ba6/plotting-30.hires.png and b/dev/_downloads/ce89ed58fdb41bf7840cc83d6e6a1ba6/plotting-30.hires.png differ diff --git a/dev/_downloads/d1eadb36634e8e0276f3d1752e83893e/matrices-14.pdf b/dev/_downloads/d1eadb36634e8e0276f3d1752e83893e/matrices-14.pdf index 5d2a3cc0c03..e95e4433ecb 100644 Binary files a/dev/_downloads/d1eadb36634e8e0276f3d1752e83893e/matrices-14.pdf and b/dev/_downloads/d1eadb36634e8e0276f3d1752e83893e/matrices-14.pdf differ diff --git a/dev/_downloads/d2c03725fdbe7104e13f46e3798a03e1/beam-7.pdf b/dev/_downloads/d2c03725fdbe7104e13f46e3798a03e1/beam-7.pdf index 27346507b6b..928e8de0a5a 100644 Binary files a/dev/_downloads/d2c03725fdbe7104e13f46e3798a03e1/beam-7.pdf and b/dev/_downloads/d2c03725fdbe7104e13f46e3798a03e1/beam-7.pdf differ diff --git a/dev/_downloads/d3453595eb36f834c2ad86d18546535c/matrices-7.pdf b/dev/_downloads/d3453595eb36f834c2ad86d18546535c/matrices-7.pdf index fa542b43269..907abcddffc 100644 Binary files a/dev/_downloads/d3453595eb36f834c2ad86d18546535c/matrices-7.pdf and b/dev/_downloads/d3453595eb36f834c2ad86d18546535c/matrices-7.pdf differ diff --git a/dev/_downloads/d4935c2256660a8a33a7af58457af366/beam-6.pdf b/dev/_downloads/d4935c2256660a8a33a7af58457af366/beam-6.pdf index 1b629b452ed..0d51d316242 100644 Binary files a/dev/_downloads/d4935c2256660a8a33a7af58457af366/beam-6.pdf and b/dev/_downloads/d4935c2256660a8a33a7af58457af366/beam-6.pdf differ diff --git a/dev/_downloads/d8f4bbfa41aeb33459953469d86ea8b1/plotting-32_03.pdf b/dev/_downloads/d8f4bbfa41aeb33459953469d86ea8b1/plotting-32_03.pdf index 2ff05e84b46..c638d321522 100644 Binary files a/dev/_downloads/d8f4bbfa41aeb33459953469d86ea8b1/plotting-32_03.pdf and b/dev/_downloads/d8f4bbfa41aeb33459953469d86ea8b1/plotting-32_03.pdf differ diff --git a/dev/_downloads/dac00acb10450bde21ecfc4fd9c34817/matrices-1.pdf b/dev/_downloads/dac00acb10450bde21ecfc4fd9c34817/matrices-1.pdf index 39bc3366ced..a4b1ff474cb 100644 Binary files a/dev/_downloads/dac00acb10450bde21ecfc4fd9c34817/matrices-1.pdf and b/dev/_downloads/dac00acb10450bde21ecfc4fd9c34817/matrices-1.pdf differ diff --git a/dev/_downloads/db76a3db1d29ef7f72c47b067c360357/plotting-24.hires.png b/dev/_downloads/db76a3db1d29ef7f72c47b067c360357/plotting-24.hires.png index e66f17f3df7..d13d5723540 100644 Binary files a/dev/_downloads/db76a3db1d29ef7f72c47b067c360357/plotting-24.hires.png and b/dev/_downloads/db76a3db1d29ef7f72c47b067c360357/plotting-24.hires.png differ diff --git a/dev/_downloads/ddddc4679201fda850a702ce6ca7ff1e/plotting-5.pdf b/dev/_downloads/ddddc4679201fda850a702ce6ca7ff1e/plotting-5.pdf index 744db483b94..008a2ae27d0 100644 Binary files a/dev/_downloads/ddddc4679201fda850a702ce6ca7ff1e/plotting-5.pdf and b/dev/_downloads/ddddc4679201fda850a702ce6ca7ff1e/plotting-5.pdf differ diff --git a/dev/_downloads/e0563f4c3c89c72192ce76efd2e6fe6b/matrices-3.pdf b/dev/_downloads/e0563f4c3c89c72192ce76efd2e6fe6b/matrices-3.pdf index dc85178a6bc..ad70bab820d 100644 Binary files a/dev/_downloads/e0563f4c3c89c72192ce76efd2e6fe6b/matrices-3.pdf and b/dev/_downloads/e0563f4c3c89c72192ce76efd2e6fe6b/matrices-3.pdf differ diff --git a/dev/_downloads/e07f3720dbc2048eb106de8a904dcfa9/plotting-25.pdf b/dev/_downloads/e07f3720dbc2048eb106de8a904dcfa9/plotting-25.pdf index a1d22697237..e3c60819b7e 100644 Binary files a/dev/_downloads/e07f3720dbc2048eb106de8a904dcfa9/plotting-25.pdf and b/dev/_downloads/e07f3720dbc2048eb106de8a904dcfa9/plotting-25.pdf differ diff --git a/dev/_downloads/e51f495094ca971c2da007d95d7c6aff/matrices-5.pdf b/dev/_downloads/e51f495094ca971c2da007d95d7c6aff/matrices-5.pdf index 5c7f5f718b0..517cf28fe3a 100644 Binary files a/dev/_downloads/e51f495094ca971c2da007d95d7c6aff/matrices-5.pdf and b/dev/_downloads/e51f495094ca971c2da007d95d7c6aff/matrices-5.pdf differ diff --git a/dev/_downloads/e8a5010f49b1076156ddfe2fa5fe6189/beam-9.pdf b/dev/_downloads/e8a5010f49b1076156ddfe2fa5fe6189/beam-9.pdf index 4f81467d5df..a4ee7ca5fa9 100644 Binary files a/dev/_downloads/e8a5010f49b1076156ddfe2fa5fe6189/beam-9.pdf and b/dev/_downloads/e8a5010f49b1076156ddfe2fa5fe6189/beam-9.pdf differ diff --git a/dev/_downloads/eb990a3106294a2a2f898aea0b429ab7/matrices-23.pdf b/dev/_downloads/eb990a3106294a2a2f898aea0b429ab7/matrices-23.pdf index b7ed6e9cc65..ed44d1b1bd5 100644 Binary files a/dev/_downloads/eb990a3106294a2a2f898aea0b429ab7/matrices-23.pdf and b/dev/_downloads/eb990a3106294a2a2f898aea0b429ab7/matrices-23.pdf differ diff --git a/dev/_downloads/ebf272f79479d63cc5b71ad0f0e41f7d/fourier-1.pdf b/dev/_downloads/ebf272f79479d63cc5b71ad0f0e41f7d/fourier-1.pdf index b7920bfee40..33c18a8e950 100644 Binary files a/dev/_downloads/ebf272f79479d63cc5b71ad0f0e41f7d/fourier-1.pdf and b/dev/_downloads/ebf272f79479d63cc5b71ad0f0e41f7d/fourier-1.pdf differ diff --git a/dev/_downloads/ee22a6375b132bbe50ac86a0282c8f8f/fourier-2.pdf b/dev/_downloads/ee22a6375b132bbe50ac86a0282c8f8f/fourier-2.pdf index 2331a7c7065..0dc453c2939 100644 Binary files a/dev/_downloads/ee22a6375b132bbe50ac86a0282c8f8f/fourier-2.pdf and b/dev/_downloads/ee22a6375b132bbe50ac86a0282c8f8f/fourier-2.pdf differ diff --git a/dev/_downloads/ef1b602db6b31a5b8d8b9d20a2410f41/beam-10.pdf b/dev/_downloads/ef1b602db6b31a5b8d8b9d20a2410f41/beam-10.pdf index 4bddd678378..f8ed589cd91 100644 Binary files a/dev/_downloads/ef1b602db6b31a5b8d8b9d20a2410f41/beam-10.pdf and b/dev/_downloads/ef1b602db6b31a5b8d8b9d20a2410f41/beam-10.pdf differ diff --git a/dev/_downloads/f0b1ed1309beacf065f53d41a069ebe1/plotting-24.pdf b/dev/_downloads/f0b1ed1309beacf065f53d41a069ebe1/plotting-24.pdf index 39e2e6867ae..0237eb0b9b9 100644 Binary files a/dev/_downloads/f0b1ed1309beacf065f53d41a069ebe1/plotting-24.pdf and b/dev/_downloads/f0b1ed1309beacf065f53d41a069ebe1/plotting-24.pdf differ diff --git a/dev/_downloads/f0f9e180dc0f510887f7768447a685c0/biomechanics-13.pdf b/dev/_downloads/f0f9e180dc0f510887f7768447a685c0/biomechanics-13.pdf index f471a63443b..4757f89ec2b 100644 Binary files a/dev/_downloads/f0f9e180dc0f510887f7768447a685c0/biomechanics-13.pdf and b/dev/_downloads/f0f9e180dc0f510887f7768447a685c0/biomechanics-13.pdf differ diff --git a/dev/_downloads/f143e8af7f67232f463360136b513860/truss-1.pdf b/dev/_downloads/f143e8af7f67232f463360136b513860/truss-1.pdf index 75bd0f82603..f54ac36f7b9 100644 Binary files a/dev/_downloads/f143e8af7f67232f463360136b513860/truss-1.pdf and b/dev/_downloads/f143e8af7f67232f463360136b513860/truss-1.pdf differ diff --git a/dev/_downloads/f80c921d3706d4105017533fa107b084/control_plots-6.hires.png b/dev/_downloads/f80c921d3706d4105017533fa107b084/control_plots-6.hires.png index 54f2abdee5a..ac5cf212725 100644 Binary files a/dev/_downloads/f80c921d3706d4105017533fa107b084/control_plots-6.hires.png and b/dev/_downloads/f80c921d3706d4105017533fa107b084/control_plots-6.hires.png differ diff --git a/dev/_downloads/fd7d64e97562f1e8bfd34628ef58f000/plotting-31_01.pdf b/dev/_downloads/fd7d64e97562f1e8bfd34628ef58f000/plotting-31_01.pdf index 2eee1ab0154..7b3315e61f0 100644 Binary files a/dev/_downloads/fd7d64e97562f1e8bfd34628ef58f000/plotting-31_01.pdf and b/dev/_downloads/fd7d64e97562f1e8bfd34628ef58f000/plotting-31_01.pdf differ diff --git a/dev/_downloads/fd8f37f13aecb42027ed8c23548b8132/plotting-31_00.pdf b/dev/_downloads/fd8f37f13aecb42027ed8c23548b8132/plotting-31_00.pdf index 21546f60c3e..11bcfff8d37 100644 Binary files a/dev/_downloads/fd8f37f13aecb42027ed8c23548b8132/plotting-31_00.pdf and b/dev/_downloads/fd8f37f13aecb42027ed8c23548b8132/plotting-31_00.pdf differ diff --git a/dev/_images/control_plots-6.png b/dev/_images/control_plots-6.png index e9e03ceb26f..f26fdfb5cea 100644 Binary files a/dev/_images/control_plots-6.png and b/dev/_images/control_plots-6.png differ diff --git a/dev/_images/plotting-24.png b/dev/_images/plotting-24.png index 7456f578bb3..cb7af77fea4 100644 Binary files a/dev/_images/plotting-24.png and b/dev/_images/plotting-24.png differ diff --git a/dev/_images/plotting-25.png b/dev/_images/plotting-25.png index 6def3325cc2..c8beac16141 100644 Binary files a/dev/_images/plotting-25.png and b/dev/_images/plotting-25.png differ diff --git a/dev/_images/plotting-26.png b/dev/_images/plotting-26.png index d39895362f2..f4a53ddc785 100644 Binary files a/dev/_images/plotting-26.png and b/dev/_images/plotting-26.png differ diff --git a/dev/_images/plotting-29.png b/dev/_images/plotting-29.png index 3b8ce1ca09f..39f99bd0648 100644 Binary files a/dev/_images/plotting-29.png and b/dev/_images/plotting-29.png differ diff --git a/dev/_images/plotting-30.png b/dev/_images/plotting-30.png index 7d6a513f665..6827f3c01da 100644 Binary files a/dev/_images/plotting-30.png and b/dev/_images/plotting-30.png differ diff --git a/dev/explanation/gotchas.html b/dev/explanation/gotchas.html index 18f9f1ff1f5..7786972ac84 100644 --- a/dev/explanation/gotchas.html +++ b/dev/explanation/gotchas.html @@ -1574,7 +1574,7 @@

help()
measure=<function count_ops>,
-)[source] +)[source]

Reduce expression by combining powers with similar bases and exponents.

Explanation

If deep is True then powsimp() will also simplify arguments of diff --git a/dev/modules/algebras.html b/dev/modules/algebras.html index c614593eac2..219624e399f 100644 --- a/dev/modules/algebras.html +++ b/dev/modules/algebras.html @@ -824,7 +824,7 @@

Introductionnorm=None,

-)[source] +)[source]

Provides basic quaternion operations. Quaternion objects can be instantiated as Quaternion(a, b, c, d) as in \(q = a + bi + cj + dk\).

@@ -879,7 +879,7 @@

Introduction
-add(other)[source]
+add(other)[source]

Adds quaternions.

Parameters:
@@ -921,7 +921,7 @@

Introduction
-angle()[source]
+angle()[source]

Returns the angle of the quaternion measured in the real-axis plane.

Explanation

Given a quaternion \(q = a + bi + cj + dk\) where \(a\), \(b\), \(c\) and \(d\) @@ -941,7 +941,7 @@

Introduction
-arc_coplanar(other)[source]
+arc_coplanar(other)[source]

Returns True if the transformation arcs represented by the input quaternions happen in the same plane.

Parameters:
@@ -977,7 +977,7 @@

Introduction
-axis()[source]
+axis()[source]

Returns \(\mathbf{Ax}(q)\), the axis of the quaternion \(q\).

Explanation

Given a quaternion \(q = a + bi + cj + dk\), returns \(\mathbf{Ax}(q)\) i.e., the versor of the vector part of that quaternion @@ -998,7 +998,7 @@

Introduction
-exp()[source]
+exp()[source]

Returns the exponential of \(q\), given by \(e^q\).

Returns:
@@ -1022,7 +1022,7 @@

Introduction
-classmethod from_Matrix(elements)[source]
+classmethod from_Matrix(elements)[source]

Returns quaternion from elements of a column vector`. If vector_only is True, returns only imaginary part as a Matrix of length 3.

@@ -1058,7 +1058,7 @@

Introduction
-classmethod from_axis_angle(vector, angle)[source]
+classmethod from_axis_angle(vector, angle)[source]

Returns a rotation quaternion given the axis and the angle of rotation.

Parameters:
@@ -1090,7 +1090,7 @@

Introduction
-classmethod from_euler(angles, seq)[source]
+classmethod from_euler(angles, seq)[source]

Returns quaternion equivalent to rotation represented by the Euler angles, in the sequence defined by seq.

@@ -1138,7 +1138,7 @@

Introduction
-classmethod from_rotation_matrix(M)[source]
+classmethod from_rotation_matrix(M)[source]

Returns the equivalent quaternion of a matrix. The quaternion will be normalized only if the matrix is special orthogonal (orthogonal and det(M) = 1).

@@ -1170,7 +1170,7 @@

Introduction
-index_vector()[source]
+index_vector()[source]

Returns the index vector of the quaternion.

Returns:
@@ -1195,7 +1195,7 @@

Introduction
-integrate(*args)[source]
+integrate(*args)[source]

Computes integration of quaternion.

Returns:
@@ -1226,13 +1226,13 @@

Introduction
-inverse()[source]
+inverse()[source]

Returns the inverse of the quaternion.

-is_pure()[source]
+is_pure()[source]

Returns true if the quaternion is pure, false if the quaternion is not pure or returns none if it is unknown.

Explanation

@@ -1253,7 +1253,7 @@

Introduction
-is_zero_quaternion()[source]
+is_zero_quaternion()[source]

Returns true if the quaternion is a zero quaternion or false if it is not a zero quaternion and None if the value is unknown.

Explanation

@@ -1279,7 +1279,7 @@

Introduction
-log()[source]
+log()[source]

Returns the logarithm of the quaternion, given by \(\log q\).

Examples

>>> from sympy import Quaternion
@@ -1295,7 +1295,7 @@ 

Introduction
-mensor()[source]
+mensor()[source]

Returns the natural logarithm of the norm(magnitude) of the quaternion.

Examples

>>> from sympy.algebras.quaternion import Quaternion
@@ -1314,7 +1314,7 @@ 

Introduction
-mul(other)[source]
+mul(other)[source]

Multiplies quaternions.

Parameters:
@@ -1356,19 +1356,19 @@

Introduction
-norm()[source]
+norm()[source]

Returns the norm of the quaternion.

-normalize()[source]
+normalize()[source]

Returns the normalized form of the quaternion.

-orthogonal(other)[source]
+orthogonal(other)[source]

Returns the orthogonality of two quaternions.

Parameters:
@@ -1400,7 +1400,7 @@

Introduction
-parallel(other)[source]
+parallel(other)[source]

Returns True if the two pure quaternions seen as 3D vectors are parallel.

Parameters:
@@ -1432,7 +1432,7 @@

Introduction
-pow(p)[source]
+pow(p)[source]

Finds the pth power of the quaternion.

Parameters:
@@ -1460,7 +1460,7 @@

Introduction
-pow_cos_sin(p)[source]
+pow_cos_sin(p)[source]

Computes the pth power in the cos-sin form.

Parameters:
@@ -1585,7 +1585,7 @@

Introduction
-static rotate_point(pin, r)[source]
+static rotate_point(pin, r)[source]

Returns the coordinates of the point pin (a 3 tuple) after rotation.

Parameters:
@@ -1624,7 +1624,7 @@

Introduction
-scalar_part()[source]
+scalar_part()[source]

Returns scalar part(\(\mathbf{S}(q)\)) of the quaternion q.

Explanation

Given a quaternion \(q = a + bi + cj + dk\), returns \(\mathbf{S}(q) = a\).

@@ -1639,7 +1639,7 @@

Introduction
-set_norm(norm)[source]
+set_norm(norm)[source]

Sets norm of an already instantiated quaternion.

Parameters:
@@ -1674,7 +1674,7 @@

Introduction
-to_Matrix(vector_only=False)[source]
+to_Matrix(vector_only=False)[source]

Returns elements of quaternion as a column vector. By default, a Matrix of length 4 is returned, with the real part as the first element. @@ -1722,7 +1722,7 @@

Introduction
-to_axis_angle()[source]
+to_axis_angle()[source]

Returns the axis and angle of rotation of a quaternion.

Returns:
@@ -1754,7 +1754,7 @@

Introductionavoid_square_root=False,

-)[source] +)[source]

Returns Euler angles representing same rotation as the quaternion, in the sequence given by seq. This implements the method described in [R3].

@@ -1829,7 +1829,7 @@

Introductionhomogeneous=True,

-)[source] +)[source]

Returns the equivalent rotation transformation matrix of the quaternion which represents rotation about the origin if v is not passed.

@@ -1872,7 +1872,7 @@

Introduction
-classmethod vector_coplanar(q1, q2, q3)[source]
+classmethod vector_coplanar(q1, q2, q3)[source]

Returns True if the axis of the pure quaternions seen as 3D vectors q1, q2, and q3 are coplanar.

@@ -1924,7 +1924,7 @@

Introduction
-vector_part()[source]
+vector_part()[source]

Returns \(\mathbf{V}(q)\), the vector part of the quaternion \(q\).

Explanation

Given a quaternion \(q = a + bi + cj + dk\), returns \(\mathbf{V}(q) = bi + cj + dk\).

diff --git a/dev/modules/assumptions/ask.html b/dev/modules/assumptions/ask.html index 680d457b8f7..b866d575d24 100644 --- a/dev/modules/assumptions/ask.html +++ b/dev/modules/assumptions/ask.html @@ -806,14 +806,14 @@
Documentation Version

Module for querying SymPy objects about assumptions.

-class sympy.assumptions.ask.AssumptionKeys[source]
+class sympy.assumptions.ask.AssumptionKeys[source]

This class contains all the supported keys by ask. It should be accessed via the instance sympy.Q.

-sympy.assumptions.ask.ask(proposition, assumptions=True, context={})[source]
+sympy.assumptions.ask.ask(proposition, assumptions=True, context={})[source]

Function to evaluate the proposition with assumptions.

Parameters:
@@ -903,7 +903,7 @@
Documentation Version
-sympy.assumptions.ask.register_handler(key, handler)[source]
+sympy.assumptions.ask.register_handler(key, handler)[source]

Register a handler in the ask system. key must be a string and handler a class inheriting from AskHandler.

@@ -913,7 +913,7 @@
Documentation Version
-sympy.assumptions.ask.remove_handler(key, handler)[source]
+sympy.assumptions.ask.remove_handler(key, handler)[source]

Removes a handler from the ask system.

Deprecated since version 1.8.: Use multipledispatch handler instead. See Predicate.

diff --git a/dev/modules/assumptions/assume.html b/dev/modules/assumptions/assume.html index b85e4655701..c983c7b732e 100644 --- a/dev/modules/assumptions/assume.html +++ b/dev/modules/assumptions/assume.html @@ -806,7 +806,7 @@
Documentation Version

A module which implements predicates and assumption context.

-class sympy.assumptions.assume.AppliedPredicate(predicate, *args)[source]
+class sympy.assumptions.assume.AppliedPredicate(predicate, *args)[source]

The class of expressions resulting from applying Predicate to the arguments. AppliedPredicate merely wraps its argument and remain unevaluated. To evaluate it, use the ask() function.

@@ -861,7 +861,7 @@
Documentation Version
-class sympy.assumptions.assume.AssumptionsContext[source]
+class sympy.assumptions.assume.AssumptionsContext[source]

Set containing default assumptions which are applied to the ask() function.

Explanation

@@ -906,7 +906,7 @@
Documentation Version
-add(*assumptions)[source]
+add(*assumptions)[source]

Add assumptions.

@@ -914,7 +914,7 @@
Documentation Version
-class sympy.assumptions.assume.Predicate(*args, **kwargs)[source]
+class sympy.assumptions.assume.Predicate(*args, **kwargs)[source]

Base class for mathematical predicates. It also serves as a constructor for undefined predicate objects.

Explanation

@@ -986,7 +986,7 @@
Documentation Version
-eval(args, assumptions=True)[source]
+eval(args, assumptions=True)[source]

Evaluate self(*args) under the given assumptions.

This uses only direct resolution methods, not logical inference.

@@ -998,13 +998,13 @@
Documentation Version
-classmethod register(*types, **kwargs)[source]
+classmethod register(*types, **kwargs)[source]

Register the signature to the handler.

-classmethod register_many(*types, **kwargs)[source]
+classmethod register_many(*types, **kwargs)[source]

Register multiple signatures to same handler.

@@ -1012,7 +1012,7 @@
Documentation Version
-class sympy.assumptions.assume.UndefinedPredicate(name, handlers=None)[source]
+class sympy.assumptions.assume.UndefinedPredicate(name, handlers=None)[source]

Predicate without handler.

Explanation

This predicate is generated by using Predicate directly for @@ -1031,7 +1031,7 @@

Documentation Version
-sympy.assumptions.assume.assuming(*assumptions)[source]
+sympy.assumptions.assume.assuming(*assumptions)[source]

Context manager for assumptions.

Examples

>>> from sympy import assuming, Q, ask
diff --git a/dev/modules/assumptions/index.html b/dev/modules/assumptions/index.html
index e39169c0bf7..1f6a7144276 100644
--- a/dev/modules/assumptions/index.html
+++ b/dev/modules/assumptions/index.html
@@ -808,7 +808,7 @@ 
Documentation Version

Predicate

-class sympy.assumptions.assume.Predicate(*args, **kwargs)[source]
+class sympy.assumptions.assume.Predicate(*args, **kwargs)[source]

Base class for mathematical predicates. It also serves as a constructor for undefined predicate objects.

Explanation

@@ -880,7 +880,7 @@

Predicate
-eval(args, assumptions=True)[source]
+eval(args, assumptions=True)[source]

Evaluate self(*args) under the given assumptions.

This uses only direct resolution methods, not logical inference.

@@ -892,13 +892,13 @@

Predicate
-classmethod register(*types, **kwargs)[source]
+classmethod register(*types, **kwargs)[source]

Register the signature to the handler.

-classmethod register_many(*types, **kwargs)[source]
+classmethod register_many(*types, **kwargs)[source]

Register multiple signatures to same handler.

@@ -906,7 +906,7 @@

Predicate
-class sympy.assumptions.assume.AppliedPredicate(predicate, *args)[source]
+class sympy.assumptions.assume.AppliedPredicate(predicate, *args)[source]

The class of expressions resulting from applying Predicate to the arguments. AppliedPredicate merely wraps its argument and remain unevaluated. To evaluate it, use the ask() function.

@@ -966,7 +966,7 @@

Querying is ask():

-sympy.assumptions.ask.ask(proposition, assumptions=True, context={})[source]
+sympy.assumptions.ask.ask(proposition, assumptions=True, context={})[source]

Function to evaluate the proposition with assumptions.

Parameters:
diff --git a/dev/modules/assumptions/predicates.html b/dev/modules/assumptions/predicates.html index 68a187bae6f..c734a305485 100644 --- a/dev/modules/assumptions/predicates.html +++ b/dev/modules/assumptions/predicates.html @@ -807,7 +807,7 @@
Documentation Version

Common

-class sympy.assumptions.predicates.common.IsTruePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.common.IsTruePredicate(*args, **kwargs)[source]

Generic predicate.

Explanation

ask(Q.is_true(x)) is true iff x is true. This only makes @@ -852,7 +852,7 @@

Common
-class sympy.assumptions.predicates.common.CommutativePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.common.CommutativePredicate(*args, **kwargs)[source]

Commutative predicate.

Explanation

ask(Q.commutative(x)) is true iff x commutes with any other @@ -872,7 +872,7 @@

CommonCalculus

-class sympy.assumptions.predicates.calculus.FinitePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.calculus.FinitePredicate(*args, **kwargs)[source]

Finite number predicate.

Explanation

Q.finite(x) is true if x is a number but neither an infinity @@ -916,7 +916,7 @@

Calculus
-class sympy.assumptions.predicates.calculus.InfinitePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.calculus.InfinitePredicate(*args, **kwargs)[source]

Infinite number predicate.

Q.infinite(x) is true iff the absolute value of x is infinity.

@@ -935,7 +935,7 @@

Calculus

Matrix

-class sympy.assumptions.predicates.matrices.SymmetricPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.SymmetricPredicate(*args, **kwargs)[source]

Symmetric matrix predicate.

Explanation

Q.symmetric(x) is true iff x is a square matrix and is equal to @@ -972,7 +972,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.InvertiblePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.InvertiblePredicate(*args, **kwargs)[source]

Invertible matrix predicate.

Explanation

Q.invertible(x) is true iff x is an invertible matrix. @@ -1009,7 +1009,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.OrthogonalPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.OrthogonalPredicate(*args, **kwargs)[source]

Orthogonal matrix predicate.

Explanation

Q.orthogonal(x) is true iff x is an orthogonal matrix. @@ -1051,7 +1051,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.UnitaryPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.UnitaryPredicate(*args, **kwargs)[source]

Unitary matrix predicate.

Explanation

Q.unitary(x) is true iff x is a unitary matrix. @@ -1090,7 +1090,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.PositiveDefinitePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.PositiveDefinitePredicate(*args, **kwargs)[source]

Positive definite matrix predicate.

Explanation

If \(M\) is a \(n \times n\) symmetric real matrix, it is said @@ -1129,7 +1129,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.UpperTriangularPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.UpperTriangularPredicate(*args, **kwargs)[source]

Upper triangular matrix predicate.

Explanation

A matrix \(M\) is called upper triangular matrix if \(M_{ij}=0\) @@ -1161,7 +1161,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.LowerTriangularPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.LowerTriangularPredicate(*args, **kwargs)[source]

Lower triangular matrix predicate.

Explanation

A matrix \(M\) is called lower triangular matrix if \(M_{ij}=0\) @@ -1193,7 +1193,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.DiagonalPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.DiagonalPredicate(*args, **kwargs)[source]

Diagonal matrix predicate.

Explanation

Q.diagonal(x) is true iff x is a diagonal matrix. A diagonal @@ -1228,7 +1228,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.FullRankPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.FullRankPredicate(*args, **kwargs)[source]

Fullrank matrix predicate.

Explanation

Q.fullrank(x) is true iff x is a full rank matrix. @@ -1258,7 +1258,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.SquarePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.SquarePredicate(*args, **kwargs)[source]

Square matrix predicate.

Explanation

Q.square(x) is true iff x is a square matrix. A square matrix @@ -1296,7 +1296,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.IntegerElementsPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.IntegerElementsPredicate(*args, **kwargs)[source]

Integer elements matrix predicate.

Explanation

Q.integer_elements(x) is true iff all the elements of x @@ -1320,7 +1320,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.RealElementsPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.RealElementsPredicate(*args, **kwargs)[source]

Real elements matrix predicate.

Explanation

Q.real_elements(x) is true iff all the elements of x @@ -1344,7 +1344,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.ComplexElementsPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.ComplexElementsPredicate(*args, **kwargs)[source]

Complex elements matrix predicate.

Explanation

Q.complex_elements(x) is true iff all the elements of x @@ -1370,7 +1370,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.SingularPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.SingularPredicate(*args, **kwargs)[source]

Singular matrix predicate.

A matrix is singular iff the value of its determinant is 0.

Examples

@@ -1401,7 +1401,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.NormalPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.NormalPredicate(*args, **kwargs)[source]

Normal matrix predicate.

A matrix is normal if it commutes with its conjugate transpose.

Examples

@@ -1430,7 +1430,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.TriangularPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.TriangularPredicate(*args, **kwargs)[source]

Triangular matrix predicate.

Explanation

Q.triangular(X) is true if X is one that is either lower @@ -1463,7 +1463,7 @@

Matrix
-class sympy.assumptions.predicates.matrices.UnitTriangularPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.matrices.UnitTriangularPredicate(*args, **kwargs)[source]

Unit triangular matrix predicate.

Explanation

A unit triangular matrix is a triangular matrix with 1s @@ -1490,7 +1490,7 @@

MatrixNumber Theory

-class sympy.assumptions.predicates.ntheory.EvenPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.ntheory.EvenPredicate(*args, **kwargs)[source]

Even number predicate.

Explanation

ask(Q.even(x)) is true iff x belongs to the set of even @@ -1519,7 +1519,7 @@

Number Theory
-class sympy.assumptions.predicates.ntheory.OddPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.ntheory.OddPredicate(*args, **kwargs)[source]

Odd number predicate.

Explanation

ask(Q.odd(x)) is true iff x belongs to the set of odd numbers.

@@ -1547,7 +1547,7 @@

Number Theory
-class sympy.assumptions.predicates.ntheory.PrimePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.ntheory.PrimePredicate(*args, **kwargs)[source]

Prime number predicate.

Explanation

ask(Q.prime(x)) is true iff x is a natural number greater @@ -1579,7 +1579,7 @@

Number Theory
-class sympy.assumptions.predicates.ntheory.CompositePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.ntheory.CompositePredicate(*args, **kwargs)[source]

Composite number predicate.

Explanation

ask(Q.composite(x)) is true iff x is a positive integer and has @@ -1611,7 +1611,7 @@

Number Theory

-class sympy.assumptions.predicates.order.PositivePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.order.PositivePredicate(*args, **kwargs)[source]

Positive real number predicate.

Explanation

Q.positive(x) is true iff x is real and \(x > 0\), that is if x @@ -1659,7 +1659,7 @@

Order
-class sympy.assumptions.predicates.order.NegativePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.order.NegativePredicate(*args, **kwargs)[source]

Negative number predicate.

Explanation

Q.negative(x) is true iff x is a real number and \(x < 0\), that is, @@ -1707,7 +1707,7 @@

Order
-class sympy.assumptions.predicates.order.ZeroPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.order.ZeroPredicate(*args, **kwargs)[source]

Zero number predicate.

Explanation

ask(Q.zero(x)) is true iff the value of x is zero.

@@ -1738,7 +1738,7 @@

Order
-class sympy.assumptions.predicates.order.NonZeroPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.order.NonZeroPredicate(*args, **kwargs)[source]

Nonzero real number predicate.

Explanation

ask(Q.nonzero(x)) is true iff x is real and x is not zero. Note in @@ -1785,7 +1785,7 @@

Order
-class sympy.assumptions.predicates.order.NonPositivePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.order.NonPositivePredicate(*args, **kwargs)[source]

Nonpositive real number predicate.

Explanation

ask(Q.nonpositive(x)) is true iff x belongs to the set of @@ -1829,7 +1829,7 @@

Order
-class sympy.assumptions.predicates.order.NonNegativePredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.order.NonNegativePredicate(*args, **kwargs)[source]

Nonnegative real number predicate.

Explanation

ask(Q.nonnegative(x)) is true iff x belongs to the set of @@ -1874,7 +1874,7 @@

Order

Sets

-class sympy.assumptions.predicates.sets.IntegerPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.IntegerPredicate(*args, **kwargs)[source]

Integer predicate.

Explanation

Q.integer(x) is true iff x belongs to the set of integer @@ -1907,7 +1907,7 @@

Sets
-class sympy.assumptions.predicates.sets.RationalPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.RationalPredicate(*args, **kwargs)[source]

Rational number predicate.

Explanation

Q.rational(x) is true iff x belongs to the set of @@ -1942,7 +1942,7 @@

Sets
-class sympy.assumptions.predicates.sets.IrrationalPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.IrrationalPredicate(*args, **kwargs)[source]

Irrational number predicate.

Explanation

Q.irrational(x) is true iff x is any real number that @@ -1979,7 +1979,7 @@

Sets
-class sympy.assumptions.predicates.sets.RealPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.RealPredicate(*args, **kwargs)[source]

Real number predicate.

Explanation

Q.real(x) is true iff x is a real number, i.e., it is in the @@ -2050,7 +2050,7 @@

Sets
-class sympy.assumptions.predicates.sets.ExtendedRealPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.ExtendedRealPredicate(*args, **kwargs)[source]

Extended real predicate.

Explanation

Q.extended_real(x) is true iff x is a real number or @@ -2081,7 +2081,7 @@

Sets
-class sympy.assumptions.predicates.sets.HermitianPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.HermitianPredicate(*args, **kwargs)[source]

Hermitian predicate.

Explanation

ask(Q.hermitian(x)) is true iff x belongs to the set of @@ -2106,7 +2106,7 @@

Sets
-class sympy.assumptions.predicates.sets.ComplexPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.ComplexPredicate(*args, **kwargs)[source]

Complex number predicate.

Explanation

Q.complex(x) is true iff x belongs to the set of complex @@ -2142,7 +2142,7 @@

Sets
-class sympy.assumptions.predicates.sets.ImaginaryPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.ImaginaryPredicate(*args, **kwargs)[source]

Imaginary number predicate.

Explanation

Q.imaginary(x) is true iff x can be written as a real @@ -2179,7 +2179,7 @@

Sets
-class sympy.assumptions.predicates.sets.AntihermitianPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.AntihermitianPredicate(*args, **kwargs)[source]

Antihermitian predicate.

Explanation

Q.antihermitian(x) is true iff x belongs to the field of @@ -2206,7 +2206,7 @@

Sets
-class sympy.assumptions.predicates.sets.AlgebraicPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.AlgebraicPredicate(*args, **kwargs)[source]

Algebraic number predicate.

Explanation

Q.algebraic(x) is true iff x belongs to the set of @@ -2246,7 +2246,7 @@

Sets
-class sympy.assumptions.predicates.sets.TranscendentalPredicate(*args, **kwargs)[source]
+class sympy.assumptions.predicates.sets.TranscendentalPredicate(*args, **kwargs)[source]

Transcedental number predicate.

Explanation

Q.transcendental(x) is true iff x belongs to the set of diff --git a/dev/modules/assumptions/refine.html b/dev/modules/assumptions/refine.html index b15ea720c11..682698c7ec4 100644 --- a/dev/modules/assumptions/refine.html +++ b/dev/modules/assumptions/refine.html @@ -805,7 +805,7 @@

Documentation Version

Refine

-sympy.assumptions.refine.refine(expr, assumptions=True)[source]
+sympy.assumptions.refine.refine(expr, assumptions=True)[source]

Simplify an expression using assumptions.

Explanation

Unlike simplify() which performs structural simplification @@ -843,7 +843,7 @@

Documentation Version
-sympy.assumptions.refine.refine_Pow(expr, assumptions)[source]
+sympy.assumptions.refine.refine_Pow(expr, assumptions)[source]

Handler for instances of Pow.

Examples

>>> from sympy import Q
@@ -871,7 +871,7 @@ 
Documentation Version
-sympy.assumptions.refine.refine_abs(expr, assumptions)[source]
+sympy.assumptions.refine.refine_abs(expr, assumptions)[source]

Handler for the absolute value.

Examples

>>> from sympy import Q, Abs
@@ -888,7 +888,7 @@ 
Documentation Version
-sympy.assumptions.refine.refine_arg(expr, assumptions)[source]
+sympy.assumptions.refine.refine_arg(expr, assumptions)[source]

Handler for complex argument

Explanation

>>> from sympy.assumptions.refine import refine_arg
@@ -904,7 +904,7 @@ 
Documentation Version
-sympy.assumptions.refine.refine_atan2(expr, assumptions)[source]
+sympy.assumptions.refine.refine_atan2(expr, assumptions)[source]

Handler for the atan2 function.

Examples

>>> from sympy import Q, atan2
@@ -930,7 +930,7 @@ 
Documentation Version
-sympy.assumptions.refine.refine_im(expr, assumptions)[source]
+sympy.assumptions.refine.refine_im(expr, assumptions)[source]

Handler for imaginary part.

Explanation

>>> from sympy.assumptions.refine import refine_im
@@ -946,7 +946,7 @@ 
Documentation Version
-sympy.assumptions.refine.refine_matrixelement(expr, assumptions)[source]
+sympy.assumptions.refine.refine_matrixelement(expr, assumptions)[source]

Handler for symmetric part.

Examples

>>> from sympy.assumptions.refine import refine_matrixelement
@@ -962,7 +962,7 @@ 
Documentation Version
-sympy.assumptions.refine.refine_re(expr, assumptions)[source]
+sympy.assumptions.refine.refine_re(expr, assumptions)[source]

Handler for real part.

Examples

>>> from sympy.assumptions.refine import refine_re
@@ -978,7 +978,7 @@ 
Documentation Version
-sympy.assumptions.refine.refine_sign(expr, assumptions)[source]
+sympy.assumptions.refine.refine_sign(expr, assumptions)[source]

Handler for sign.

Examples

>>> from sympy.assumptions.refine import refine_sign
diff --git a/dev/modules/calculus/index.html b/dev/modules/calculus/index.html
index 613d3a632eb..1fdb133ec18 100644
--- a/dev/modules/calculus/index.html
+++ b/dev/modules/calculus/index.html
@@ -808,7 +808,7 @@ 
Documentation Version
Euler-Lagrange Equations for given Lagrangian.

-sympy.calculus.euler.euler_equations(L, funcs=(), vars=())[source]
+sympy.calculus.euler.euler_equations(L, funcs=(), vars=())[source]

Find the Euler-Lagrange equations [R31] for a given Lagrangian.

Parameters:
@@ -894,7 +894,7 @@
Documentation Version
symbol=None,
-)[source] +)[source]

Return whether the function is decreasing in the given interval.

Parameters:
@@ -952,7 +952,7 @@
Documentation Version
symbol=None,
-)[source] +)[source]

Return whether the function is increasing in the given interval.

Parameters:
@@ -1006,7 +1006,7 @@
Documentation Version
symbol=None,
-)[source] +)[source]

Return whether the function is monotonic in the given interval.

Parameters:
@@ -1068,7 +1068,7 @@
Documentation Version
symbol=None,
-)[source] +)[source]

Return whether the function is strictly decreasing in the given interval.

Parameters:
@@ -1122,7 +1122,7 @@
Documentation Version
symbol=None,
-)[source] +)[source]

Return whether the function is strictly increasing in the given interval.

Parameters:
@@ -1177,7 +1177,7 @@
Documentation Version
symbol=None,
-)[source] +)[source]

Helper function for functions checking function monotonicity.

Parameters:
@@ -1216,7 +1216,7 @@
Documentation Version
-sympy.calculus.singularities.singularities(expression, symbol, domain=None)[source]
+sympy.calculus.singularities.singularities(expression, symbol, domain=None)[source]

Find singularities of a given function.

Parameters:
@@ -1303,7 +1303,7 @@
Documentation Version
-sympy.calculus.finite_diff.apply_finite_diff(order, x_list, y_list, x0=0)[source]
+sympy.calculus.finite_diff.apply_finite_diff(order, x_list, y_list, x0=0)[source]

Calculates the finite difference approximation of the derivative of requested order at x0 from points provided in x_list and y_list.

@@ -1383,7 +1383,7 @@
Documentation Version
evaluate=False,
-)[source] +)[source]

Differentiate expr and replace Derivatives with finite differences.

Parameters:
@@ -1435,7 +1435,7 @@
Documentation Version
-sympy.calculus.finite_diff.finite_diff_weights(order, x_list, x0=1)[source]
+sympy.calculus.finite_diff.finite_diff_weights(order, x_list, x0=1)[source]

Calculates the finite difference weights for an arbitrarily spaced one-dimensional grid (x_list) for derivatives at x0 of order 0, 1, …, up to order using a recursive formula. Order of accuracy @@ -1573,7 +1573,7 @@

Documentation Version
-sympy.calculus.util.continuous_domain(f, symbol, domain)[source]
+sympy.calculus.util.continuous_domain(f, symbol, domain)[source]

Returns the domain on which the function expression f is continuous.

This function is limited by the ability to determine the various singularities and discontinuities of the given function. @@ -1626,7 +1626,7 @@

Documentation Version
-sympy.calculus.util.function_range(f, symbol, domain)[source]
+sympy.calculus.util.function_range(f, symbol, domain)[source]

Finds the range of a function in a given domain. This method is limited by the ability to determine the singularities and determine limits.

@@ -1683,7 +1683,7 @@
Documentation Version
-sympy.calculus.util.is_convex(f, *syms, domain=Reals)[source]
+sympy.calculus.util.is_convex(f, *syms, domain=Reals)[source]

Determines the convexity of the function passed in the argument.

Parameters:
@@ -1760,7 +1760,7 @@
Documentation Version
-sympy.calculus.util.lcim(numbers)[source]
+sympy.calculus.util.lcim(numbers)[source]

Returns the least common integral multiple of a list of numbers.

The numbers can be rational or irrational or a mixture of both. \(None\) is returned for incommensurable numbers.

@@ -1792,7 +1792,7 @@
Documentation Version
-sympy.calculus.util.maximum(f, symbol, domain=Reals)[source]
+sympy.calculus.util.maximum(f, symbol, domain=Reals)[source]

Returns the maximum value of a function in the given domain.

Parameters:
@@ -1839,7 +1839,7 @@
Documentation Version
-sympy.calculus.util.minimum(f, symbol, domain=Reals)[source]
+sympy.calculus.util.minimum(f, symbol, domain=Reals)[source]

Returns the minimum value of a function in the given domain.

Parameters:
@@ -1886,7 +1886,7 @@
Documentation Version
-sympy.calculus.util.not_empty_in(finset_intersection, *syms)[source]
+sympy.calculus.util.not_empty_in(finset_intersection, *syms)[source]

Finds the domain of the functions in finset_intersection in which the finite_set is not-empty.

@@ -1933,7 +1933,7 @@
Documentation Version
-sympy.calculus.util.periodicity(f, symbol, check=False)[source]
+sympy.calculus.util.periodicity(f, symbol, check=False)[source]

Tests the given function for periodicity in the given symbol.

Parameters:
@@ -1993,7 +1993,7 @@
Documentation Version
-sympy.calculus.util.stationary_points(f, symbol, domain=Reals)[source]
+sympy.calculus.util.stationary_points(f, symbol, domain=Reals)[source]

Returns the stationary points of a function (where derivative of the function is 0) in the given domain.

diff --git a/dev/modules/categories.html b/dev/modules/categories.html index 515f4ebbb97..afd8c7ecdde 100644 --- a/dev/modules/categories.html +++ b/dev/modules/categories.html @@ -829,7 +829,7 @@

Introduction
-class sympy.categories.Object(name, **assumptions)[source]
+class sympy.categories.Object(name, **assumptions)[source]

The base class for any kind of object in an abstract category.

Explanation

While technically any instance of Basic will do, this @@ -839,7 +839,7 @@

Introduction
-class sympy.categories.Morphism(domain, codomain)[source]
+class sympy.categories.Morphism(domain, codomain)[source]

The base class for any morphism in an abstract category.

Explanation

In abstract categories, a morphism is an arrow between two @@ -872,7 +872,7 @@

Introduction
-compose(other)[source]
+compose(other)[source]

Composes self with the supplied morphism.

The order of elements in the composition is the usual order, i.e., to construct \(g\circ f\) use g.compose(f).

@@ -913,7 +913,7 @@

Introduction
-class sympy.categories.NamedMorphism(domain, codomain, name)[source]
+class sympy.categories.NamedMorphism(domain, codomain, name)[source]

Represents a morphism which has a name.

Explanation

Names are used to distinguish between morphisms which have the @@ -953,7 +953,7 @@

Introduction
-class sympy.categories.CompositeMorphism(*components)[source]
+class sympy.categories.CompositeMorphism(*components)[source]

Represents a morphism which is a composition of other morphisms.

Explanation

Two composite morphisms are equal if the morphisms they were @@ -1035,7 +1035,7 @@

Introduction
-flatten(new_name)[source]
+flatten(new_name)[source]

Forgets the composite structure of this morphism.

Explanation

If new_name is not empty, returns a NamedMorphism @@ -1060,7 +1060,7 @@

Introduction
-class sympy.categories.IdentityMorphism(domain)[source]
+class sympy.categories.IdentityMorphism(domain)[source]

Represents an identity morphism.

Explanation

An identity morphism is a morphism with equal domain and codomain, @@ -1094,7 +1094,7 @@

Introductioncommutative_diagrams=EmptySet,

-)[source] +)[source]

An (abstract) category.

Explanation

A category [JoyOfCats] is a quadruple \(\mbox{K} = (O, \hom, id, @@ -1191,7 +1191,7 @@

Introduction
-class sympy.categories.Diagram(*args)[source]
+class sympy.categories.Diagram(*args)[source]

Represents a diagram in a certain category.

Explanation

Informally, a diagram is a collection of objects of a category and @@ -1265,7 +1265,7 @@

Introduction
-hom(A, B)[source]
+hom(A, B)[source]

Returns a 2-tuple of sets of morphisms between objects A and B: one set of morphisms listed as premises, and the other set of morphisms listed as conclusions.

@@ -1290,7 +1290,7 @@

Introduction
-is_subdiagram(diagram)[source]
+is_subdiagram(diagram)[source]

Checks whether diagram is a subdiagram of self. Diagram \(D'\) is a subdiagram of \(D\) if all premises (conclusions) of \(D'\) are contained in the premises @@ -1355,7 +1355,7 @@

Introduction
-subdiagram_from_objects(objects)[source]
+subdiagram_from_objects(objects)[source]

If objects is a subset of the objects of self, returns a diagram which has as premises all those premises of self which have a domains and codomains in objects, likewise @@ -1385,7 +1385,7 @@

Introduction
-class sympy.categories.diagram_drawing.DiagramGrid(diagram, groups=None, **hints)[source]
+class sympy.categories.diagram_drawing.DiagramGrid(diagram, groups=None, **hints)[source]

Constructs and holds the fitting of the diagram into a grid.

Explanation

The mission of this class is to analyse the structure of the @@ -1588,7 +1588,7 @@

Introductionlabel,

-)[source] +)[source]

Stores the information necessary for producing an Xy-pic description of an arrow.

The principal goal of this class is to abstract away the string @@ -1683,7 +1683,7 @@

Introduction
-class sympy.categories.diagram_drawing.XypicDiagramDrawer[source]
+class sympy.categories.diagram_drawing.XypicDiagramDrawer[source]

Given a Diagram and the corresponding DiagramGrid, produces the Xy-pic representation of the diagram.

@@ -1805,7 +1805,7 @@

Introductiondiagram_format='',

-)[source] +)[source]

Returns the Xy-pic representation of diagram laid out in grid.

Consider the following simple triangle diagram.

@@ -1868,7 +1868,7 @@

Introduction**hints,

-)[source] +)[source]

Provides a shortcut combining DiagramGrid and XypicDiagramDrawer. Returns an Xy-pic presentation of diagram. The argument masked is a list of morphisms which @@ -1915,7 +1915,7 @@

Introduction**hints,

-)[source] +)[source]

Combines the functionality of xypic_draw_diagram and sympy.printing.preview. The arguments masked, diagram_format, groups, and hints are passed to diff --git a/dev/modules/codegen.html b/dev/modules/codegen.html index 62a88da2698..7aa49695970 100644 --- a/dev/modules/codegen.html +++ b/dev/modules/codegen.html @@ -1344,7 +1344,7 @@

Autowrap
opportunistic=True,

-)[source] +)[source]

Specialization of ReplaceOptim for functions evaluating “f(x) - 1”.

Parameters:
@@ -1383,7 +1383,7 @@

Autowrap

-replace_in_Add(e)[source]
+replace_in_Add(e)[source]

passed as second argument to Basic.replace(…)

@@ -1391,7 +1391,7 @@

Autowrap
-class sympy.codegen.rewriting.Optimization(cost_function=None, priority=1)[source]
+class sympy.codegen.rewriting.Optimization(cost_function=None, priority=1)[source]

Abstract base class for rewriting optimization.

Subclasses should implement __call__ taking an expression as argument.

@@ -1405,7 +1405,7 @@

Autowrap
-class sympy.codegen.rewriting.ReplaceOptim(query, value, **kwargs)[source]
+class sympy.codegen.rewriting.ReplaceOptim(query, value, **kwargs)[source]

Rewriting optimization calling replace on expressions.

Parameters:
@@ -1446,7 +1446,7 @@

Autowrap
base_req=<function <lambda>>,

-)[source] +)[source]

Creates an instance of ReplaceOptim for expanding Pow.

Parameters:
@@ -1483,7 +1483,7 @@

Autowrap
-sympy.codegen.rewriting.optimize(expr, optimizations)[source]
+sympy.codegen.rewriting.optimize(expr, optimizations)[source]

Apply optimizations to an expression.

Parameters:
@@ -1524,7 +1524,7 @@

Autowrap

-class sympy.codegen.matrix_nodes.MatrixSolve(*args, **kwargs)[source]
+class sympy.codegen.matrix_nodes.MatrixSolve(*args, **kwargs)[source]

Represents an operation to solve a linear matrix equation.

Parameters:
@@ -1572,7 +1572,7 @@

Autowrap
**kwargs,

-)[source] +)[source]

Approximates functions by expanding them as a series.

Parameters:
@@ -1619,7 +1619,7 @@

Autowrap
-class sympy.codegen.approximations.SumApprox(bounds, reltol, **kwargs)[source]
+class sympy.codegen.approximations.SumApprox(bounds, reltol, **kwargs)[source]

Approximates sum by neglecting small terms.

Parameters:
@@ -1781,7 +1781,7 @@

Using the nodes
-class sympy.codegen.ast.Assignment(lhs, rhs)[source]
+class sympy.codegen.ast.Assignment(lhs, rhs)[source]

Represents variable assignment for code generation.

Parameters:
@@ -1821,7 +1821,7 @@

Using the nodes
-class sympy.codegen.ast.AssignmentBase(lhs, rhs)[source]
+class sympy.codegen.ast.AssignmentBase(lhs, rhs)[source]

Abstract base class for Assignment and AugmentedAssignment.

Attributes:

@@ -1832,7 +1832,7 @@

Using the nodes
-class sympy.codegen.ast.Attribute(possibly parametrized)[source]
+class sympy.codegen.ast.Attribute(possibly parametrized)[source]

For use with sympy.codegen.ast.Node (which takes instances of Attribute as attrs).

@@ -1859,7 +1859,7 @@

Using the nodes
-class sympy.codegen.ast.AugmentedAssignment(lhs, rhs)[source]
+class sympy.codegen.ast.AugmentedAssignment(lhs, rhs)[source]

Base class for augmented assignments.

Attributes:

@@ -1871,7 +1871,7 @@

Using the nodes
-class sympy.codegen.ast.BreakToken(*args, **kwargs)[source]
+class sympy.codegen.ast.BreakToken(*args, **kwargs)[source]

Represents ‘break’ in C/Python (‘exit’ in Fortran).

Use the premade instance break_ or instantiate manually.

Examples

@@ -1887,7 +1887,7 @@

Using the nodes
-class sympy.codegen.ast.CodeBlock(*args)[source]
+class sympy.codegen.ast.CodeBlock(*args)[source]

Represents a block of code.

Explanation

For now only assignments are supported. This restriction will be lifted in @@ -1932,7 +1932,7 @@

Using the nodesorder='canonical',

-)[source] +)[source]

Return a new code block with common subexpressions eliminated.

Explanation

See the docstring of sympy.simplify.cse_main.cse() for more @@ -1962,7 +1962,7 @@

Using the nodes
-classmethod topological_sort(assignments)[source]
+classmethod topological_sort(assignments)[source]

Return a CodeBlock with topologically sorted assignments so that variables are assigned before they are used.

Examples

@@ -1994,19 +1994,19 @@

Using the nodes
-class sympy.codegen.ast.Comment(*args, **kwargs)[source]
+class sympy.codegen.ast.Comment(*args, **kwargs)[source]

Represents a comment.

-class sympy.codegen.ast.ComplexType(*args, **kwargs)[source]
+class sympy.codegen.ast.ComplexType(*args, **kwargs)[source]

Represents a complex floating point number.

-class sympy.codegen.ast.ContinueToken(*args, **kwargs)[source]
+class sympy.codegen.ast.ContinueToken(*args, **kwargs)[source]

Represents ‘continue’ in C/Python (‘cycle’ in Fortran)

Use the premade instance continue_ or instantiate manually.

Examples

@@ -2022,7 +2022,7 @@

Using the nodes
-class sympy.codegen.ast.Declaration(*args, **kwargs)[source]
+class sympy.codegen.ast.Declaration(*args, **kwargs)[source]

Represents a variable declaration

Parameters:
@@ -2047,7 +2047,7 @@

Using the nodes
-class sympy.codegen.ast.Element(*args, **kwargs)[source]
+class sympy.codegen.ast.Element(*args, **kwargs)[source]

Element in (a possibly N-dimensional) array.

Examples

>>> from sympy.codegen.ast import Element
@@ -2067,11 +2067,11 @@ 

Using the nodes
-class sympy.codegen.ast.FloatBaseType(*args, **kwargs)[source]
+class sympy.codegen.ast.FloatBaseType(*args, **kwargs)[source]

Represents a floating point number type.

-cast_nocheck[source]
+cast_nocheck[source]

alias of Float

@@ -2079,7 +2079,7 @@

Using the nodes
-class sympy.codegen.ast.FloatType(*args, **kwargs)[source]
+class sympy.codegen.ast.FloatType(*args, **kwargs)[source]

Represents a floating point type with fixed bit width.

Base 2 & one sign bit is assumed.

@@ -2126,7 +2126,7 @@

Using the nodes
-cast_nocheck(value)[source]
+cast_nocheck(value)[source]

Casts without checking if out of bounds or subnormal.

@@ -2183,7 +2183,7 @@

Using the nodes
-class sympy.codegen.ast.For(*args, **kwargs)[source]
+class sympy.codegen.ast.For(*args, **kwargs)[source]

Represents a ‘for-loop’ in the code.

@@ -2235,7 +2235,7 @@

Using the nodes
-class sympy.codegen.ast.FunctionCall(*args, **kwargs)[source]
+class sympy.codegen.ast.FunctionCall(*args, **kwargs)[source]

Represents a call to a function in the code.

Parameters:
@@ -2255,7 +2255,7 @@

Using the nodes
-class sympy.codegen.ast.FunctionDefinition(*args, **kwargs)[source]
+class sympy.codegen.ast.FunctionDefinition(*args, **kwargs)[source]

Represents a function definition in the code.

Parameters:
@@ -2286,7 +2286,7 @@

Using the nodes
-class sympy.codegen.ast.FunctionPrototype(*args, **kwargs)[source]
+class sympy.codegen.ast.FunctionPrototype(*args, **kwargs)[source]

Represents a function prototype

Allows the user to generate forward declaration in e.g. C/C++.

@@ -2310,13 +2310,13 @@

Using the nodes
-class sympy.codegen.ast.IntBaseType(*args, **kwargs)[source]
+class sympy.codegen.ast.IntBaseType(*args, **kwargs)[source]

Integer base type, contains no size information.

-class sympy.codegen.ast.Node(*args, **kwargs)[source]
+class sympy.codegen.ast.Node(*args, **kwargs)[source]

Subclass of Token, carrying the attribute ‘attrs’ (Tuple)

Examples

>>> from sympy.codegen.ast import Node, value_const, pointer_const
@@ -2335,7 +2335,7 @@ 

Using the nodes
-attr_params(looking_for)[source]
+attr_params(looking_for)[source]

Returns the parameters of the Attribute with name looking_for in self.attrs

@@ -2343,7 +2343,7 @@

Using the nodes
-class sympy.codegen.ast.NoneToken(*args, **kwargs)[source]
+class sympy.codegen.ast.NoneToken(*args, **kwargs)[source]

The AST equivalence of Python’s NoneType

The corresponding instance of Python’s None is none.

Examples

@@ -2357,7 +2357,7 @@

Using the nodes
-class sympy.codegen.ast.Pointer(*args, **kwargs)[source]
+class sympy.codegen.ast.Pointer(*args, **kwargs)[source]

Represents a pointer. See Variable.

Examples

Can create instances of Element:

@@ -2373,7 +2373,7 @@

Using the nodes
-class sympy.codegen.ast.Print(*args, **kwargs)[source]
+class sympy.codegen.ast.Print(*args, **kwargs)[source]

Represents print command in the code.

Parameters:
@@ -2392,19 +2392,19 @@

Using the nodes
-class sympy.codegen.ast.QuotedString(*args, **kwargs)[source]
+class sympy.codegen.ast.QuotedString(*args, **kwargs)[source]

Represents a string which should be printed with quotes.

-class sympy.codegen.ast.Raise(*args, **kwargs)[source]
+class sympy.codegen.ast.Raise(*args, **kwargs)[source]

Prints as ‘raise …’ in Python, ‘throw …’ in C++

-class sympy.codegen.ast.Return(*args, **kwargs)[source]
+class sympy.codegen.ast.Return(*args, **kwargs)[source]

Represents a return command in the code.

Parameters:
@@ -2424,14 +2424,14 @@

Using the nodes
-class sympy.codegen.ast.RuntimeError_(*args, **kwargs)[source]
+class sympy.codegen.ast.RuntimeError_(*args, **kwargs)[source]

Represents ‘std::runtime_error’ in C++ and ‘RuntimeError’ in Python.

Note that the latter is uncommon, and you might want to use e.g. ValueError.

-class sympy.codegen.ast.Scope(*args, **kwargs)[source]
+class sympy.codegen.ast.Scope(*args, **kwargs)[source]

Represents a scope in the code.

Parameters:
@@ -2445,13 +2445,13 @@

Using the nodes
-class sympy.codegen.ast.SignedIntType(*args, **kwargs)[source]
+class sympy.codegen.ast.SignedIntType(*args, **kwargs)[source]

Represents a signed integer type.

-class sympy.codegen.ast.Stream(*args, **kwargs)[source]
+class sympy.codegen.ast.Stream(*args, **kwargs)[source]

Represents a stream.

There are two predefined Stream instances stdout & stderr.

@@ -2473,7 +2473,7 @@

Using the nodes
-class sympy.codegen.ast.String(*args, **kwargs)[source]
+class sympy.codegen.ast.String(*args, **kwargs)[source]

SymPy object representing a string.

Atomic object which is not an expression (as opposed to Symbol).

@@ -2498,7 +2498,7 @@

Using the nodes
-class sympy.codegen.ast.Token(*args, **kwargs)[source]
+class sympy.codegen.ast.Token(*args, **kwargs)[source]

Base class for the AST types.

Explanation

Defining fields are set in _fields. Attributes (defined in _fields) @@ -2512,7 +2512,7 @@

Using the nodesnot_in_args are not passed to Basic.

-kwargs(exclude=(), apply=None)[source]
+kwargs(exclude=(), apply=None)[source]

Get instance’s attributes as dict of keyword arguments.

Parameters:
@@ -2532,7 +2532,7 @@

Using the nodes
-class sympy.codegen.ast.Type(*args, **kwargs)[source]
+class sympy.codegen.ast.Type(*args, **kwargs)[source]

Represents a type.

Parameters:
@@ -2596,7 +2596,7 @@

Using the nodesprecision_targets=None,

-)[source] +)[source]

Casts a value to the data type of the instance.

Parameters:
@@ -2650,7 +2650,7 @@

Using the nodes
-classmethod from_expr(expr)[source]
+classmethod from_expr(expr)[source]

Deduces type from an expression or a Symbol.

Parameters:
@@ -2682,13 +2682,13 @@

Using the nodes
-class sympy.codegen.ast.UnsignedIntType(*args, **kwargs)[source]
+class sympy.codegen.ast.UnsignedIntType(*args, **kwargs)[source]

Represents an unsigned integer type.

-class sympy.codegen.ast.Variable(*args, **kwargs)[source]
+class sympy.codegen.ast.Variable(*args, **kwargs)[source]

Represents a variable.

Parameters:
@@ -2740,7 +2740,7 @@

Using the nodes
-as_Declaration(**kwargs)[source]
+as_Declaration(**kwargs)[source]

Convenience method for creating a Declaration instance.

Explanation

If the variable of the Declaration need to wrap a modified @@ -2775,7 +2775,7 @@

Using the nodescast_check=True,

-)[source] +)[source]

Alt. constructor with type deduction from Type.from_expr.

Deduces type primarily from symbol, secondarily from value.

@@ -2813,7 +2813,7 @@

Using the nodes
-class sympy.codegen.ast.While(*args, **kwargs)[source]
+class sympy.codegen.ast.While(*args, **kwargs)[source]

Represents a ‘for-loop’ in the code.

Expressions are of the form:
@@ -2846,7 +2846,7 @@

Using the nodes
-sympy.codegen.ast.aug_assign(lhs, op, rhs)[source]
+sympy.codegen.ast.aug_assign(lhs, op, rhs)[source]

Create ‘lhs op= rhs’.

Parameters:
@@ -2893,7 +2893,7 @@

Using the nodes
-class sympy.codegen.cfunctions.Cbrt(*args)[source]
+class sympy.codegen.cfunctions.Cbrt(*args)[source]

Represents the cube root function.

Explanation

The reason why one would use Cbrt(x) over cbrt(x) @@ -2914,7 +2914,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -2922,7 +2922,7 @@

Using the nodes
-class sympy.codegen.cfunctions.Sqrt(*args)[source]
+class sympy.codegen.cfunctions.Sqrt(*args)[source]

Represents the square root function.

Explanation

The reason why one would use Sqrt(x) over sqrt(x) @@ -2943,7 +2943,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -2951,7 +2951,7 @@

Using the nodes
-class sympy.codegen.cfunctions.exp2(arg)[source]
+class sympy.codegen.cfunctions.exp2(arg)[source]

Represents the exponential function with base two.

Explanation

The benefit of using exp2(x) over 2**x @@ -2972,7 +2972,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -2980,7 +2980,7 @@

Using the nodes
-class sympy.codegen.cfunctions.expm1(arg)[source]
+class sympy.codegen.cfunctions.expm1(arg)[source]

Represents the exponential function minus one.

Explanation

The benefit of using expm1(x) over exp(x) - 1 @@ -3004,7 +3004,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -3012,7 +3012,7 @@

Using the nodes
-class sympy.codegen.cfunctions.fma(*args)[source]
+class sympy.codegen.cfunctions.fma(*args)[source]

Represents “fused multiply add”.

Explanation

The benefit of using fma(x, y, z) over x*y + z @@ -3027,7 +3027,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -3035,7 +3035,7 @@

Using the nodes
-class sympy.codegen.cfunctions.hypot(*args)[source]
+class sympy.codegen.cfunctions.hypot(*args)[source]

Represents the hypotenuse function.

Explanation

The hypotenuse function is provided by e.g. the math library @@ -3054,7 +3054,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -3062,7 +3062,7 @@

Using the nodes
-class sympy.codegen.cfunctions.log10(arg)[source]
+class sympy.codegen.cfunctions.log10(arg)[source]

Represents the logarithm function with base ten.

Examples

>>> from sympy.abc import x
@@ -3079,7 +3079,7 @@ 

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -3087,7 +3087,7 @@

Using the nodes
-class sympy.codegen.cfunctions.log1p(arg)[source]
+class sympy.codegen.cfunctions.log1p(arg)[source]

Represents the natural logarithm of a number plus one.

Explanation

The benefit of using log1p(x) over log(x + 1) @@ -3112,7 +3112,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -3120,7 +3120,7 @@

Using the nodes
-class sympy.codegen.cfunctions.log2(arg)[source]
+class sympy.codegen.cfunctions.log2(arg)[source]

Represents the logarithm function with base two.

Explanation

The benefit of using log2(x) over log(x)/log(2) @@ -3141,7 +3141,7 @@

Using the nodes
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of this function.

@@ -3153,13 +3153,13 @@

Using the nodes
-class sympy.codegen.cnodes.CommaOperator(*args)[source]
+class sympy.codegen.cnodes.CommaOperator(*args)[source]

Represents the comma operator in C

-class sympy.codegen.cnodes.Label(*args, **kwargs)[source]
+class sympy.codegen.cnodes.Label(*args, **kwargs)[source]

Label for use with e.g. goto statement.

Examples

>>> from sympy import ccode, Symbol
@@ -3175,7 +3175,7 @@ 

Using the nodes
-class sympy.codegen.cnodes.PostDecrement(*args)[source]
+class sympy.codegen.cnodes.PostDecrement(*args)[source]

Represents the post-decrement operator

Examples

>>> from sympy.abc import x
@@ -3189,7 +3189,7 @@ 

Using the nodes
-class sympy.codegen.cnodes.PostIncrement(*args)[source]
+class sympy.codegen.cnodes.PostIncrement(*args)[source]

Represents the post-increment operator

Examples

>>> from sympy.abc import x
@@ -3203,7 +3203,7 @@ 

Using the nodes
-class sympy.codegen.cnodes.PreDecrement(*args)[source]
+class sympy.codegen.cnodes.PreDecrement(*args)[source]

Represents the pre-decrement operator

Examples

>>> from sympy.abc import x
@@ -3217,7 +3217,7 @@ 

Using the nodes
-class sympy.codegen.cnodes.PreIncrement(*args)[source]
+class sympy.codegen.cnodes.PreIncrement(*args)[source]

Represents the pre-increment operator

Examples

>>> from sympy.abc import x
@@ -3231,19 +3231,19 @@ 

Using the nodes
-sympy.codegen.cnodes.alignof(arg)[source]
+sympy.codegen.cnodes.alignof(arg)[source]

Generate of FunctionCall instance for calling ‘alignof’

-class sympy.codegen.cnodes.goto(*args, **kwargs)[source]
+class sympy.codegen.cnodes.goto(*args, **kwargs)[source]

Represents goto in C

-sympy.codegen.cnodes.sizeof(arg)[source]
+sympy.codegen.cnodes.sizeof(arg)[source]

Generate of FunctionCall instance for calling ‘sizeof’

Examples

>>> from sympy.codegen.ast import real
@@ -3257,13 +3257,13 @@ 

Using the nodes
-class sympy.codegen.cnodes.struct(*args, **kwargs)[source]
+class sympy.codegen.cnodes.struct(*args, **kwargs)[source]

Represents a struct in C

-class sympy.codegen.cnodes.union(*args, **kwargs)[source]
+class sympy.codegen.cnodes.union(*args, **kwargs)[source]

Represents a union in C

@@ -3273,7 +3273,7 @@

Using the nodes
-class sympy.codegen.cxxnodes.using(*args, **kwargs)[source]
+class sympy.codegen.cxxnodes.using(*args, **kwargs)[source]

Represents a ‘using’ statement in C++

@@ -3285,7 +3285,7 @@

Using the nodes
-class sympy.codegen.fnodes.ArrayConstructor(*args, **kwargs)[source]
+class sympy.codegen.fnodes.ArrayConstructor(*args, **kwargs)[source]

Represents an array constructor.

Examples

>>> from sympy import fcode
@@ -3301,7 +3301,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.Do(*args, **kwargs)[source]
+class sympy.codegen.fnodes.Do(*args, **kwargs)[source]

Represents a Do loop in in Fortran.

Examples

>>> from sympy import fcode, symbols
@@ -3328,7 +3328,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.Extent(*args)[source]
+class sympy.codegen.fnodes.Extent(*args)[source]

Represents a dimension extent.

Examples

>>> from sympy.codegen.fnodes import Extent
@@ -3348,7 +3348,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.FortranReturn(*args, **kwargs)[source]
+class sympy.codegen.fnodes.FortranReturn(*args, **kwargs)[source]

AST node explicitly mapped to a fortran “return”.

Explanation

Because a return statement in fortran is different from C, and @@ -3367,7 +3367,7 @@

Using the nodes
-class sympy.codegen.fnodes.GoTo(*args, **kwargs)[source]
+class sympy.codegen.fnodes.GoTo(*args, **kwargs)[source]

Represents a goto statement in Fortran

Examples

>>> from sympy.codegen.fnodes import GoTo
@@ -3381,7 +3381,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.ImpliedDoLoop(*args, **kwargs)[source]
+class sympy.codegen.fnodes.ImpliedDoLoop(*args, **kwargs)[source]

Represents an implied do loop in Fortran.

Examples

>>> from sympy import Symbol, fcode
@@ -3397,7 +3397,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.Module(*args, **kwargs)[source]
+class sympy.codegen.fnodes.Module(*args, **kwargs)[source]

Represents a module in Fortran.

Examples

>>> from sympy.codegen.fnodes import Module
@@ -3416,7 +3416,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.Program(*args, **kwargs)[source]
+class sympy.codegen.fnodes.Program(*args, **kwargs)[source]

Represents a ‘program’ block in Fortran.

Examples

>>> from sympy.codegen.ast import Print
@@ -3433,7 +3433,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.Subroutine(*args, **kwargs)[source]
+class sympy.codegen.fnodes.Subroutine(*args, **kwargs)[source]

Represents a subroutine in Fortran.

Examples

>>> from sympy import fcode, symbols
@@ -3453,7 +3453,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.SubroutineCall(*args, **kwargs)[source]
+class sympy.codegen.fnodes.SubroutineCall(*args, **kwargs)[source]

Represents a call to a subroutine in Fortran.

Examples

>>> from sympy.codegen.fnodes import SubroutineCall
@@ -3466,7 +3466,7 @@ 

Using the nodes
-sympy.codegen.fnodes.allocated(array)[source]
+sympy.codegen.fnodes.allocated(array)[source]

Creates an AST node for a function call to Fortran’s “allocated(…)”

Examples

>>> from sympy import fcode
@@ -3492,7 +3492,7 @@ 

Using the nodestype=None,

-)[source] +)[source]

Convenience function for creating a Variable instance for a Fortran array.

Parameters:
@@ -3528,7 +3528,7 @@

Using the nodes
-sympy.codegen.fnodes.bind_C(name=None)[source]
+sympy.codegen.fnodes.bind_C(name=None)[source]

Creates an Attribute bind_C with a name.

Parameters:
@@ -3556,13 +3556,13 @@

Using the nodes
-class sympy.codegen.fnodes.cmplx(*args)[source]
+class sympy.codegen.fnodes.cmplx(*args)[source]

Fortran complex conversion function.

-sympy.codegen.fnodes.dimension(*args)[source]
+sympy.codegen.fnodes.dimension(*args)[source]

Creates a ‘dimension’ Attribute with (up to 7) extents.

Examples

>>> from sympy import fcode
@@ -3578,25 +3578,25 @@ 

Using the nodes
-class sympy.codegen.fnodes.dsign(*args)[source]
+class sympy.codegen.fnodes.dsign(*args)[source]

Fortran sign intrinsic for double precision arguments.

-class sympy.codegen.fnodes.isign(*args)[source]
+class sympy.codegen.fnodes.isign(*args)[source]

Fortran sign intrinsic for integer arguments.

-class sympy.codegen.fnodes.kind(*args)[source]
+class sympy.codegen.fnodes.kind(*args)[source]

Fortran kind function.

-sympy.codegen.fnodes.lbound(array, dim=None, kind=None)[source]
+sympy.codegen.fnodes.lbound(array, dim=None, kind=None)[source]

Creates an AST node for a function call to Fortran’s “lbound(…)”

Parameters:
@@ -3617,25 +3617,25 @@

Using the nodes
-class sympy.codegen.fnodes.literal_dp(num, dps=None, precision=None)[source]
+class sympy.codegen.fnodes.literal_dp(num, dps=None, precision=None)[source]

Fortran double precision real literal

-class sympy.codegen.fnodes.literal_sp(num, dps=None, precision=None)[source]
+class sympy.codegen.fnodes.literal_sp(num, dps=None, precision=None)[source]

Fortran single precision real literal

-class sympy.codegen.fnodes.merge(*args)[source]
+class sympy.codegen.fnodes.merge(*args)[source]

Fortran merge function

-sympy.codegen.fnodes.reshape(source, shape, pad=None, order=None)[source]
+sympy.codegen.fnodes.reshape(source, shape, pad=None, order=None)[source]

Creates an AST node for a function call to Fortran’s “reshape(…)”

Parameters:
@@ -3647,7 +3647,7 @@

Using the nodes
-sympy.codegen.fnodes.shape(source, kind=None)[source]
+sympy.codegen.fnodes.shape(source, kind=None)[source]

Creates an AST node for a function call to Fortran’s “shape(…)”

Parameters:
@@ -3667,7 +3667,7 @@

Using the nodes
-sympy.codegen.fnodes.size(array, dim=None, kind=None)[source]
+sympy.codegen.fnodes.size(array, dim=None, kind=None)[source]

Creates an AST node for a function call to Fortran’s “size(…)”

Examples

>>> from sympy import fcode, Symbol
@@ -3688,7 +3688,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.use(*args, **kwargs)[source]
+class sympy.codegen.fnodes.use(*args, **kwargs)[source]

Represents a use statement in Fortran.

Examples

>>> from sympy.codegen.fnodes import use
@@ -3705,7 +3705,7 @@ 

Using the nodes
-class sympy.codegen.fnodes.use_rename(*args, **kwargs)[source]
+class sympy.codegen.fnodes.use_rename(*args, **kwargs)[source]

Represents a renaming in a use statement in Fortran.

Examples

>>> from sympy.codegen.fnodes import use_rename, use
@@ -3743,7 +3743,7 @@ 

Using the nodesbounds=None,

-)[source] +)[source]

Generates an AST for Newton-Raphson method (a root-finding algorithm).

Parameters:
@@ -3833,7 +3833,7 @@

Using the nodes**kwargs,

-)[source] +)[source]

Generates an AST for a function implementing the Newton-Raphson method.

Parameters:
@@ -3887,7 +3887,7 @@

Using the nodes

Python utilities (sympy.codegen.pyutils)

-sympy.codegen.pyutils.render_as_module(content, standard='python3')[source]
+sympy.codegen.pyutils.render_as_module(content, standard='python3')[source]

Renders Python code as a module (with the required imports).

Parameters:
@@ -3913,7 +3913,7 @@

Using the nodessettings=None,

-)[source] +)[source]

Renders a C source file (with required #include statements)

@@ -3931,7 +3931,7 @@

Using the nodesprinter_settings=None,

-)[source] +)[source]

Creates a Module instance and renders it as a string.

This generates Fortran source code for a module with the correct use statements.

diff --git a/dev/modules/combinatorics/galois.html b/dev/modules/combinatorics/galois.html index 025f255baee..07f55863e44 100644 --- a/dev/modules/combinatorics/galois.html +++ b/dev/modules/combinatorics/galois.html @@ -839,7 +839,7 @@

Referencesboundary=None,

-)[source] +)[source]

Names for the transitive subgroups of S6.

@@ -858,7 +858,7 @@

Referencesboundary=None,

-)[source] +)[source]

Names for the transitive subgroups of S5.

@@ -877,7 +877,7 @@

Referencesboundary=None,

-)[source] +)[source]

Names for the transitive subgroups of S4.

@@ -896,7 +896,7 @@

Referencesboundary=None,

-)[source] +)[source]

Names for the transitive subgroups of S3.

@@ -915,7 +915,7 @@

Referencesboundary=None,

-)[source] +)[source]

Names for the transitive subgroups of S2.

@@ -934,20 +934,20 @@

Referencesboundary=None,

-)[source] +)[source]

Names for the transitive subgroups of S1.

-sympy.combinatorics.galois.four_group()[source]
+sympy.combinatorics.galois.four_group()[source]

Return a representation of the Klein four-group as a transitive subgroup of S4.

-sympy.combinatorics.galois.M20()[source]
+sympy.combinatorics.galois.M20()[source]

Return a representation of the metacyclic group M20, a transitive subgroup of S5 that is one of the possible Galois groups for polys of degree 5.

Notes

@@ -956,7 +956,7 @@

References
-sympy.combinatorics.galois.S3_in_S6()[source]
+sympy.combinatorics.galois.S3_in_S6()[source]

Return a representation of S3 as a transitive subgroup of S6.

Notes

The representation is found by viewing the group as the symmetries of a @@ -965,7 +965,7 @@

References
-sympy.combinatorics.galois.A4_in_S6()[source]
+sympy.combinatorics.galois.A4_in_S6()[source]

Return a representation of A4 as a transitive subgroup of S6.

Notes

This was computed using find_transitive_subgroups_of_S6().

@@ -973,7 +973,7 @@

References
-sympy.combinatorics.galois.S4m()[source]
+sympy.combinatorics.galois.S4m()[source]

Return a representation of the S4- transitive subgroup of S6.

Notes

This was computed using find_transitive_subgroups_of_S6().

@@ -981,7 +981,7 @@

References
-sympy.combinatorics.galois.S4p()[source]
+sympy.combinatorics.galois.S4p()[source]

Return a representation of the S4+ transitive subgroup of S6.

Notes

This was computed using find_transitive_subgroups_of_S6().

@@ -989,7 +989,7 @@

References
-sympy.combinatorics.galois.A4xC2()[source]
+sympy.combinatorics.galois.A4xC2()[source]

Return a representation of the (A4 x C2) transitive subgroup of S6.

Notes

This was computed using find_transitive_subgroups_of_S6().

@@ -997,7 +997,7 @@

References
-sympy.combinatorics.galois.S4xC2()[source]
+sympy.combinatorics.galois.S4xC2()[source]

Return a representation of the (S4 x C2) transitive subgroup of S6.

Notes

This was computed using find_transitive_subgroups_of_S6().

@@ -1005,7 +1005,7 @@

References
-sympy.combinatorics.galois.G18()[source]
+sympy.combinatorics.galois.G18()[source]

Return a representation of the group G18, a transitive subgroup of S6 isomorphic to the semidirect product of C3^2 with C2.

Notes

@@ -1014,7 +1014,7 @@

References
-sympy.combinatorics.galois.G36m()[source]
+sympy.combinatorics.galois.G36m()[source]

Return a representation of the group G36-, a transitive subgroup of S6 isomorphic to the semidirect product of C3^2 with C2^2.

Notes

@@ -1023,7 +1023,7 @@

References
-sympy.combinatorics.galois.G36p()[source]
+sympy.combinatorics.galois.G36p()[source]

Return a representation of the group G36+, a transitive subgroup of S6 isomorphic to the semidirect product of C3^2 with C4.

Notes

@@ -1032,7 +1032,7 @@

References
-sympy.combinatorics.galois.G72()[source]
+sympy.combinatorics.galois.G72()[source]

Return a representation of the group G72, a transitive subgroup of S6 isomorphic to the semidirect product of C3^2 with D4.

Notes

@@ -1041,7 +1041,7 @@

References
-sympy.combinatorics.galois.PSL2F5()[source]
+sympy.combinatorics.galois.PSL2F5()[source]

Return a representation of the group \(PSL_2(\mathbb{F}_5)\), as a transitive subgroup of S6, isomorphic to \(A_5\).

Notes

@@ -1050,7 +1050,7 @@

References
-sympy.combinatorics.galois.PGL2F5()[source]
+sympy.combinatorics.galois.PGL2F5()[source]

Return a representation of the group \(PGL_2(\mathbb{F}_5)\), as a transitive subgroup of S6, isomorphic to \(S_5\).

Notes

@@ -1066,7 +1066,7 @@

Referencesprint_report=False,

-)[source] +)[source]

Search for certain transitive subgroups of \(S_6\).

The symmetric group \(S_6\) has 16 different transitive subgroups, up to conjugacy. Some are more easily constructed than others. For example, the diff --git a/dev/modules/combinatorics/graycode.html b/dev/modules/combinatorics/graycode.html index b6b1965ce20..1ce6e96b54a 100644 --- a/dev/modules/combinatorics/graycode.html +++ b/dev/modules/combinatorics/graycode.html @@ -805,7 +805,7 @@

Documentation Version

Gray Code

-class sympy.combinatorics.graycode.GrayCode(n, *args, **kw_args)[source]
+class sympy.combinatorics.graycode.GrayCode(n, *args, **kw_args)[source]

A Gray code is essentially a Hamiltonian walk on a n-dimensional cube with edge length of one. The vertices of the cube are represented by vectors @@ -859,7 +859,7 @@

Documentation Version
-generate_gray(**hints)[source]
+generate_gray(**hints)[source]

Generates the sequence of bit vectors of a Gray Code.

Examples

>>> from sympy.combinatorics import GrayCode
@@ -901,7 +901,7 @@ 
Documentation Version
-next(delta=1)[source]
+next(delta=1)[source]

Returns the Gray code a distance delta (default = 1) from the current value in canonical order.

Examples

@@ -964,7 +964,7 @@
Documentation Version
-skip()[source]
+skip()[source]

Skips the bit generation.

Examples

>>> from sympy.combinatorics import GrayCode
@@ -991,7 +991,7 @@ 
Documentation Version
-classmethod unrank(n, rank)[source]
+classmethod unrank(n, rank)[source]

Unranks an n-bit sized Gray code of rank k. This method exists so that a derivative GrayCode class can define its own code of a given rank.

@@ -1015,7 +1015,7 @@
Documentation Version
-graycode.random_bitstring()[source]
+graycode.random_bitstring()[source]

Generates a random bitlist of length n.

Examples

>>> from sympy.combinatorics.graycode import random_bitstring
@@ -1027,7 +1027,7 @@ 
Documentation Version
-graycode.gray_to_bin()[source]
+graycode.gray_to_bin()[source]

Convert from Gray coding to binary coding.

We assume big endian encoding.

Examples

@@ -1044,7 +1044,7 @@
Documentation Version
-graycode.bin_to_gray()[source]
+graycode.bin_to_gray()[source]

Convert from binary coding to gray coding.

We assume big endian encoding.

Examples

@@ -1061,7 +1061,7 @@
Documentation Version
-graycode.get_subset_from_bitstring(bitstring)[source]
+graycode.get_subset_from_bitstring(bitstring)[source]

Gets the subset defined by the bitstring.

Examples

>>> from sympy.combinatorics.graycode import get_subset_from_bitstring
@@ -1079,7 +1079,7 @@ 
Documentation Version
-graycode.graycode_subsets()[source]
+graycode.graycode_subsets()[source]

Generates the subsets as enumerated by a Gray code.

Examples

>>> from sympy.combinatorics.graycode import graycode_subsets
diff --git a/dev/modules/combinatorics/group_constructs.html b/dev/modules/combinatorics/group_constructs.html
index a67c3db7e10..fabccfca883 100644
--- a/dev/modules/combinatorics/group_constructs.html
+++ b/dev/modules/combinatorics/group_constructs.html
@@ -805,7 +805,7 @@ 
Documentation Version

Group constructors

-sympy.combinatorics.group_constructs.DirectProduct(*groups)[source]
+sympy.combinatorics.group_constructs.DirectProduct(*groups)[source]

Returns the direct product of several groups as a permutation group.

Explanation

This is implemented much like the __mul__ procedure for taking the direct diff --git a/dev/modules/combinatorics/group_numbers.html b/dev/modules/combinatorics/group_numbers.html index 49a35e35b71..3e265816675 100644 --- a/dev/modules/combinatorics/group_numbers.html +++ b/dev/modules/combinatorics/group_numbers.html @@ -805,7 +805,7 @@

Documentation Version

Number of groups

-sympy.combinatorics.group_numbers.is_nilpotent_number(n) bool[source]
+sympy.combinatorics.group_numbers.is_nilpotent_number(n) bool[source]

Check whether \(n\) is a nilpotent number. A number \(n\) is said to be nilpotent if and only if every finite group of order \(n\) is nilpotent. For more information see [R48].

@@ -835,7 +835,7 @@
Documentation Version
-sympy.combinatorics.group_numbers.is_abelian_number(n) bool[source]
+sympy.combinatorics.group_numbers.is_abelian_number(n) bool[source]

Check whether \(n\) is an abelian number. A number \(n\) is said to be abelian if and only if every finite group of order \(n\) is abelian. For more information see [R50].

@@ -867,7 +867,7 @@
Documentation Version
-sympy.combinatorics.group_numbers.is_cyclic_number(n) bool[source]
+sympy.combinatorics.group_numbers.is_cyclic_number(n) bool[source]

Check whether \(n\) is a cyclic number. A number \(n\) is said to be cyclic if and only if every finite group of order \(n\) is cyclic. For more information see [R52].

@@ -899,7 +899,7 @@
Documentation Version
-sympy.combinatorics.group_numbers.groups_count(n)[source]
+sympy.combinatorics.group_numbers.groups_count(n)[source]

Number of groups of order \(n\). In [R54], gnu(n) is given, so we follow this notation here as well.

diff --git a/dev/modules/combinatorics/named_groups.html b/dev/modules/combinatorics/named_groups.html index ee115a8b749..8c39700fdda 100644 --- a/dev/modules/combinatorics/named_groups.html +++ b/dev/modules/combinatorics/named_groups.html @@ -805,7 +805,7 @@
Documentation Version

Named Groups

-sympy.combinatorics.named_groups.SymmetricGroup(n)[source]
+sympy.combinatorics.named_groups.SymmetricGroup(n)[source]

Generates the symmetric group on n elements as a permutation group.

Explanation

The generators taken are the n-cycle @@ -842,7 +842,7 @@

Documentation Version
-sympy.combinatorics.named_groups.CyclicGroup(n)[source]
+sympy.combinatorics.named_groups.CyclicGroup(n)[source]

Generates the cyclic group of order n as a permutation group.

Explanation

The generator taken is the n-cycle (0 1 2 ... n-1) @@ -868,7 +868,7 @@

Documentation Version
-sympy.combinatorics.named_groups.DihedralGroup(n)[source]
+sympy.combinatorics.named_groups.DihedralGroup(n)[source]

Generates the dihedral group \(D_n\) as a permutation group.

Explanation

The dihedral group \(D_n\) is the group of symmetries of the regular @@ -906,7 +906,7 @@

Documentation Version
-sympy.combinatorics.named_groups.AlternatingGroup(n)[source]
+sympy.combinatorics.named_groups.AlternatingGroup(n)[source]

Generates the alternating group on n elements as a permutation group.

Explanation

For n > 2, the generators taken are (0 1 2), (0 1 2 ... n-1) for @@ -941,7 +941,7 @@

Documentation Version
-sympy.combinatorics.named_groups.AbelianGroup(*cyclic_orders)[source]
+sympy.combinatorics.named_groups.AbelianGroup(*cyclic_orders)[source]

Returns the direct product of cyclic groups with the given orders.

Explanation

According to the structure theorem for finite abelian groups ([1]), diff --git a/dev/modules/combinatorics/partitions.html b/dev/modules/combinatorics/partitions.html index df2d360aa87..b7a8e5e6120 100644 --- a/dev/modules/combinatorics/partitions.html +++ b/dev/modules/combinatorics/partitions.html @@ -805,7 +805,7 @@

Documentation Version

Partitions

-class sympy.combinatorics.partitions.Partition(*partition)[source]
+class sympy.combinatorics.partitions.Partition(*partition)[source]

This class represents an abstract partition.

A partition is a set of disjoint sets whose union equals a given set.

@@ -838,7 +838,7 @@
Documentation Version
-classmethod from_rgs(rgs, elements)[source]
+classmethod from_rgs(rgs, elements)[source]

Creates a set partition from a restricted growth string.

Explanation

The indices given in rgs are assumed to be the index @@ -886,7 +886,7 @@

Documentation Version
-sort_key(order=None)[source]
+sort_key(order=None)[source]

Return a canonical key that can be used for sorting.

Ordering is based on the size and sorted elements of the partition and ties are broken with the rank.

@@ -909,7 +909,7 @@
Documentation Version
-class sympy.combinatorics.partitions.IntegerPartition(partition, integer=None)[source]
+class sympy.combinatorics.partitions.IntegerPartition(partition, integer=None)[source]

This class represents an integer partition.

Explanation

In number theory and combinatorics, a partition of a positive integer, @@ -933,7 +933,7 @@

Documentation Version
-as_dict()[source]
+as_dict()[source]

Return the partition as a dictionary whose keys are the partition integers and the values are the multiplicity of that integer.

@@ -947,7 +947,7 @@
Documentation Version
-as_ferrers(char='#')[source]
+as_ferrers(char='#')[source]

Prints the ferrer diagram of a partition.

Examples

>>> from sympy.combinatorics.partitions import IntegerPartition
@@ -974,7 +974,7 @@ 
Documentation Version
-next_lex()[source]
+next_lex()[source]

Return the next partition of the integer, n, in lexical order, wrapping around to [n] if the partition is [1, …, 1].

Examples

@@ -990,7 +990,7 @@
Documentation Version
-prev_lex()[source]
+prev_lex()[source]

Return the previous partition of the integer, n, in lexical order, wrapping around to [1, …, 1] if the partition is [n].

Examples

@@ -1008,7 +1008,7 @@
Documentation Version
-sympy.combinatorics.partitions.random_integer_partition(n, seed=None)[source]
+sympy.combinatorics.partitions.random_integer_partition(n, seed=None)[source]

Generates a random integer partition summing to n as a list of reverse-sorted integers.

Examples

@@ -1029,7 +1029,7 @@
Documentation Version
-sympy.combinatorics.partitions.RGS_generalized(m)[source]
+sympy.combinatorics.partitions.RGS_generalized(m)[source]

Computes the m + 1 generalized unrestricted growth strings and returns them as rows in matrix.

Examples

@@ -1049,7 +1049,7 @@
Documentation Version
-sympy.combinatorics.partitions.RGS_enum(m)[source]
+sympy.combinatorics.partitions.RGS_enum(m)[source]

RGS_enum computes the total number of restricted growth strings possible for a superset of size m.

Examples

@@ -1078,7 +1078,7 @@
Documentation Version
-sympy.combinatorics.partitions.RGS_unrank(rank, m)[source]
+sympy.combinatorics.partitions.RGS_unrank(rank, m)[source]

Gives the unranked restricted growth string for a given superset size.

Examples

@@ -1093,7 +1093,7 @@
Documentation Version
-sympy.combinatorics.partitions.RGS_rank(rgs)[source]
+sympy.combinatorics.partitions.RGS_rank(rgs)[source]

Computes the rank of a restricted growth string.

Examples

>>> from sympy.combinatorics.partitions import RGS_rank, RGS_unrank
diff --git a/dev/modules/combinatorics/perm_groups.html b/dev/modules/combinatorics/perm_groups.html
index 0a123fdd079..3faafbde391 100644
--- a/dev/modules/combinatorics/perm_groups.html
+++ b/dev/modules/combinatorics/perm_groups.html
@@ -805,7 +805,7 @@ 
Documentation Version

Permutation Groups

-class sympy.combinatorics.perm_groups.PermutationGroup(*args, dups=True, **kwargs)[source]
+class sympy.combinatorics.perm_groups.PermutationGroup(*args, dups=True, **kwargs)[source]

The class defining a Permutation group.

Explanation

PermutationGroup([p1, p2, ..., pn]) returns the permutation group @@ -925,7 +925,7 @@

Documentation Version
-__contains__(i)[source]
+__contains__(i)[source]

Return True if i is contained in PermutationGroup.

Examples

>>> from sympy.combinatorics import Permutation, PermutationGroup
@@ -938,7 +938,7 @@ 
Documentation Version
-__mul__(other)[source]
+__mul__(other)[source]

Return the direct product of two permutation groups as a permutation group.

Explanation

@@ -971,7 +971,7 @@
Documentation Version
**kwargs,
-)[source] +)[source]

The default constructor. Accepts Cycle and Permutation forms. Removes duplicates unless dups keyword is False.

@@ -984,14 +984,14 @@
Documentation Version
-_coset_representative(g, H)[source]
+_coset_representative(g, H)[source]

Return the representative of Hg from the transversal that would be computed by self.coset_transversal(H).

-classmethod _distinct_primes_lemma(primes)[source]
+classmethod _distinct_primes_lemma(primes)[source]

Subroutine to test if there is only one cyclic group for the order.

@@ -1005,7 +1005,7 @@
Documentation Version
perms=None,
-)[source] +)[source]

A test using monte-carlo algorithm.

Parameters:
@@ -1037,13 +1037,13 @@
Documentation Version
only_alt=False,
-)[source] +)[source]

A naive test using the group order.

-_p_elements_group(p)[source]
+_p_elements_group(p)[source]

For an abelian p-group, return the subgroup consisting of all elements of order p (and the identity)

@@ -1058,7 +1058,7 @@
Documentation Version
_random_prec_n=None,
-)[source] +)[source]

Initialize random generators for the product replacement algorithm.

Explanation

The implementation uses a modification of the original product @@ -1093,7 +1093,7 @@

Documentation Version
-_sylow_alt_sym(p)[source]
+_sylow_alt_sym(p)[source]

Return a p-Sylow subgroup of a symmetric or an alternating group.

Explanation

@@ -1140,7 +1140,7 @@
Documentation Version
not_rep,
-)[source] +)[source]

Merges two classes in a union-find data structure.

Explanation

Used in the implementation of Atkinson’s algorithm as suggested in [1], @@ -1171,7 +1171,7 @@

Documentation Version
-_union_find_rep(num, parents)[source]
+_union_find_rep(num, parents)[source]

Find representative of a class in a union-find data structure.

Explanation

Used in the implementation of Atkinson’s algorithm as suggested in [1], @@ -1201,7 +1201,7 @@

Documentation Version
-_verify(K, phi, z, alpha)[source]
+_verify(K, phi, z, alpha)[source]

Return a list of relators rels in generators gens`_h` that are mapped to ``H.generators by phi so that given a finite presentation <gens_k | rels_k> of K on a subset of gens_h @@ -1242,7 +1242,7 @@

Documentation Version
-abelian_invariants()[source]
+abelian_invariants()[source]

Returns the abelian invariants for the given group. Let G be a nontrivial finite abelian group. Then G is isomorphic to the direct product of finitely many nontrivial cyclic groups of @@ -1315,7 +1315,7 @@

Documentation Version
strong_gens_distr=None,
-)[source] +)[source]

Swap two consecutive base points in base and strong generating set.

Parameters:
@@ -1474,7 +1474,7 @@
Documentation Version
-center()[source]
+center()[source]

Return the center of a permutation group.

Explanation

The center for a group \(G\) is defined as @@ -1501,7 +1501,7 @@

Documentation Version
-centralizer(other)[source]
+centralizer(other)[source]

Return the centralizer of a group/set/element.

Parameters:
@@ -1546,7 +1546,7 @@
Documentation Version
-commutator(G, H)[source]
+commutator(G, H)[source]

Return the commutator of two subgroups.

Explanation

For a permutation group K and subgroups G, H, the @@ -1575,7 +1575,7 @@

Documentation Version
-composition_series()[source]
+composition_series()[source]

Return the composition series for a group as a list of permutation groups.

Explanation

@@ -1622,7 +1622,7 @@
Documentation Version
-conjugacy_class(x)[source]
+conjugacy_class(x)[source]

Return the conjugacy class of an element in the group.

Explanation

The conjugacy class of an element g in a group G is the set of @@ -1659,7 +1659,7 @@

Documentation Version
-conjugacy_classes()[source]
+conjugacy_classes()[source]

Return the conjugacy classes of the group.

Explanation

As described in the documentation for the .conjugacy_class() function, @@ -1676,7 +1676,7 @@

Documentation Version
-contains(g, strict=True)[source]
+contains(g, strict=True)[source]

Test if permutation g belong to self, G.

Explanation

If g is an element of G it can be written as a product @@ -1732,7 +1732,7 @@

Documentation Version
factor_index=False,
-)[source] +)[source]

Return G’s (self’s) coset factorization of g

Explanation

If g is an element of G then it can be written as the product @@ -1787,7 +1787,7 @@

Documentation Version
-coset_rank(g)[source]
+coset_rank(g)[source]

rank using Schreier-Sims representation.

Explanation

The coset rank of g is the ordering number in which @@ -1815,21 +1815,21 @@

Documentation Version
-coset_table(H)[source]
+coset_table(H)[source]

Return the standardised (right) coset table of self in H as a list of lists.

-coset_transversal(H)[source]
+coset_transversal(H)[source]

Return a transversal of the right cosets of self by its subgroup H using the second method described in [1], Subsection 4.6.7

-coset_unrank(rank, af=False)[source]
+coset_unrank(rank, af=False)[source]

unrank using Schreier-Sims representation

coset_unrank is the inverse operation of coset_rank if 0 <= rank < order; otherwise it returns None.

@@ -1865,7 +1865,7 @@
Documentation Version
-derived_series()[source]
+derived_series()[source]

Return the derived series for the group.

Returns:
@@ -1902,7 +1902,7 @@
Documentation Version
-derived_subgroup()[source]
+derived_subgroup()[source]

Compute the derived subgroup.

Explanation

The derived subgroup, or commutator subgroup is the subgroup generated @@ -1940,7 +1940,7 @@

Documentation Version
-equals(other)[source]
+equals(other)[source]

Return True if PermutationGroup generated by elements in the group are same i.e they represent the same PermutationGroup.

Examples

@@ -1965,7 +1965,7 @@
Documentation Version
af=False,
-)[source] +)[source]

Return iterator to generate the elements of the group.

Explanation

Iteration is done with one of these methods:

@@ -2010,7 +2010,7 @@
Documentation Version
-generate_dimino(af=False)[source]
+generate_dimino(af=False)[source]

Yield group elements using Dimino’s algorithm.

If af == True it yields the array form of the permutations.

Examples

@@ -2035,7 +2035,7 @@
Documentation Version
-generate_schreier_sims(af=False)[source]
+generate_schreier_sims(af=False)[source]

Yield group elements using the Schreier-Sims representation in coset_rank order

If af = True it yields the array form of the permutations

@@ -2060,7 +2060,7 @@
Documentation Version
original=False,
-)[source] +)[source]

Return a list of strong generators \([s1, \dots, sn]\) s.t \(g = sn \times \dots \times s1\). If original=True, make the list contain only the original group generators

@@ -2089,7 +2089,7 @@
Documentation Version
-index(H)[source]
+index(H)[source]

Returns the index of a permutation group.

Examples

>>> from sympy.combinatorics import Permutation, PermutationGroup
@@ -2131,7 +2131,7 @@ 
Documentation Version
_random_prec=None,
-)[source] +)[source]

Monte Carlo test for the symmetric/alternating group for degrees >= 8.

Explanation

@@ -2284,7 +2284,7 @@
Documentation Version
-is_elementary(p)[source]
+is_elementary(p)[source]

Return True if the group is elementary abelian. An elementary abelian group is a finite abelian group, where every nontrivial element has order \(p\), where \(p\) is a prime.

@@ -2333,7 +2333,7 @@
Documentation Version
-is_normal(gr, strict=True)[source]
+is_normal(gr, strict=True)[source]

Test if G=self is a normal subgroup of gr.

Explanation

G is normal in gr if @@ -2387,7 +2387,7 @@

Documentation Version
-is_primitive(randomized=True)[source]
+is_primitive(randomized=True)[source]

Test if a group is primitive.

Explanation

A permutation group G acting on a set S is called primitive if @@ -2439,7 +2439,7 @@

Documentation Version
-is_subgroup(G, strict=True)[source]
+is_subgroup(G, strict=True)[source]

Return True if all elements of self belong to G.

If strict is False then if self’s degree is smaller than G’s, the elements will be resized to have the same degree.

@@ -2515,7 +2515,7 @@
Documentation Version
-is_transitive(strict=True)[source]
+is_transitive(strict=True)[source]

Test if the group is transitive.

Explanation

A group is transitive if it has a single orbit.

@@ -2559,7 +2559,7 @@
Documentation Version
-lower_central_series()[source]
+lower_central_series()[source]

Return the lower central series for the group.

The lower central series for a group \(G\) is the series \(G = G_0 > G_1 > G_2 > \ldots\) where @@ -2588,7 +2588,7 @@

Documentation Version
-make_perm(n, seed=None)[source]
+make_perm(n, seed=None)[source]

Multiply n randomly selected permutations from pgroup together, starting with the identity permutation. If n is a list of integers, those @@ -2642,7 +2642,7 @@

Documentation Version
-minimal_block(points)[source]
+minimal_block(points)[source]

For a transitive group, finds the block system generated by points.

Explanation

@@ -2684,7 +2684,7 @@
Documentation Version
-minimal_blocks(randomized=True)[source]
+minimal_blocks(randomized=True)[source]

For a transitive group, return the list of all minimal block systems. If a group is intransitive, return \(False\).

Examples

@@ -2705,7 +2705,7 @@
Documentation Version
-normal_closure(other, k=10)[source]
+normal_closure(other, k=10)[source]

Return the normal closure of a subgroup/set of permutations.

Parameters:
@@ -2752,7 +2752,7 @@
Documentation Version
-orbit(alpha, action='tuples')[source]
+orbit(alpha, action='tuples')[source]

Compute the orbit of alpha \(\{g(\alpha) | g \in G\}\) as a set.

Explanation

The time complexity of the algorithm used here is \(O(|Orb|*r)\) where @@ -2791,7 +2791,7 @@

Documentation Version
schreier_vector=None,
-)[source] +)[source]

Return a group element which sends alpha to beta.

Explanation

If beta is not in the orbit of alpha, the function returns @@ -2819,7 +2819,7 @@

Documentation Version
pairs=False,
-)[source] +)[source]

Computes a transversal for the orbit of alpha as a set.

Explanation

For a permutation group \(G\), a transversal for the orbit @@ -2843,7 +2843,7 @@

Documentation Version
-orbits(rep=False)[source]
+orbits(rep=False)[source]

Return the orbits of self, ordered according to lowest element in each orbit.

Examples

@@ -2859,7 +2859,7 @@
Documentation Version
-order()[source]
+order()[source]

Return the order of the group: the number of permutations that can be generated from elements of the group.

The number of permutations comprising the group is given by @@ -2903,7 +2903,7 @@

Documentation Version
incremental=True,
-)[source] +)[source]

Return the pointwise stabilizer for a set of points.

Explanation

For a permutation group \(G\) and a set of points @@ -2933,7 +2933,7 @@

Documentation Version
-polycyclic_group()[source]
+polycyclic_group()[source]

Return the PolycyclicGroup instance with below parameters:

Explanation

    @@ -2950,14 +2950,14 @@
    Documentation Version
    -presentation(eliminate_gens=True)[source]
    +presentation(eliminate_gens=True)[source]

    Return an \(FpGroup\) presentation of the group.

    The algorithm is described in [1], Chapter 6.1.

    -random(af=False)[source]
    +random(af=False)[source]

    Return a random group element

    @@ -2971,7 +2971,7 @@
    Documentation Version
    _random_prec=None,
-)[source] +)[source]

Return a random group element using product replacement.

Explanation

For the details of the product replacement algorithm, see @@ -2994,7 +2994,7 @@

Documentation Version
_random_prec=None,
-)[source] +)[source]

Random element from the stabilizer of alpha.

The schreier vector for alpha is an optional argument used for speeding up repeated calls. The algorithm is described in [1], p.81

@@ -3006,7 +3006,7 @@
Documentation Version
-schreier_sims()[source]
+schreier_sims()[source]

Schreier-Sims algorithm.

Explanation

It computes the generators of the chain of stabilizers @@ -3039,7 +3039,7 @@

Documentation Version
slp_dict=False,
-)[source] +)[source]

Extend a sequence of points and generating set to a base and strong generating set.

@@ -3110,7 +3110,7 @@
Documentation Version
_random_prec=None,
-)[source] +)[source]

Randomized Schreier-Sims algorithm.

Parameters:
@@ -3180,7 +3180,7 @@
Documentation Version
-schreier_vector(alpha)[source]
+schreier_vector(alpha)[source]

Computes the schreier vector for alpha.

Explanation

The Schreier vector efficiently stores information @@ -3209,7 +3209,7 @@

Documentation Version
-stabilizer(alpha)[source]
+stabilizer(alpha)[source]

Return the stabilizer subgroup of alpha.

Explanation

The stabilizer of \(\alpha\) is the group \(G_\alpha = @@ -3259,7 +3259,7 @@

Documentation Version
-strong_presentation()[source]
+strong_presentation()[source]

Return a strong finite presentation of group. The generators of the returned group are in the same order as the strong generators of group.

@@ -3281,7 +3281,7 @@
Documentation Version
-subgroup(gens)[source]
+subgroup(gens)[source]

Return the subgroup generated by \(gens\) which is a list of elements of the group

@@ -3298,7 +3298,7 @@
Documentation Version
init_subgroup=None,
-)[source] +)[source]

Find the subgroup of all elements satisfying the property prop.

Parameters:
@@ -3377,7 +3377,7 @@
Documentation Version
-sylow_subgroup(p)[source]
+sylow_subgroup(p)[source]

Return a p-Sylow subgroup of the group.

The algorithm is described in [1], Chapter 4, Section 7

Examples

diff --git a/dev/modules/combinatorics/permutations.html b/dev/modules/combinatorics/permutations.html index 727b94cde9b..2c3da123f45 100644 --- a/dev/modules/combinatorics/permutations.html +++ b/dev/modules/combinatorics/permutations.html @@ -805,7 +805,7 @@
Documentation Version

Permutations

-class sympy.combinatorics.permutations.Permutation(*args, size=None, **kwargs)[source]
+class sympy.combinatorics.permutations.Permutation(*args, size=None, **kwargs)[source]

A permutation, alternatively known as an ‘arrangement number’ or ‘ordering’ is an arrangement of the elements of an ordered list into a one-to-one mapping with itself. The permutation of a given arrangement is given by @@ -1209,7 +1209,7 @@

Documentation Version
-apply(i)[source]
+apply(i)[source]

Apply the permutation to an expression.

Parameters:
@@ -1263,7 +1263,7 @@
Documentation Version
-ascents()[source]
+ascents()[source]

Returns the positions of ascents in a permutation, ie, the location where p[i] < p[i+1]

Examples

@@ -1281,7 +1281,7 @@
Documentation Version
-atoms()[source]
+atoms()[source]

Returns all the elements of a permutation

Examples

>>> from sympy.combinatorics import Permutation
@@ -1312,7 +1312,7 @@ 
Documentation Version
-commutator(x)[source]
+commutator(x)[source]

Return the commutator of self and x: ~x*~self*x*self

If f and g are part of a group, G, then the commutator of f and g is the group identity iff f and g commute, i.e. fg == gf.

@@ -1351,7 +1351,7 @@
Documentation Version
-commutes_with(other)[source]
+commutes_with(other)[source]

Checks if the elements are commuting.

Examples

>>> from sympy.combinatorics import Permutation
@@ -1424,7 +1424,7 @@ 
Documentation Version
-descents()[source]
+descents()[source]

Returns the positions of descents in a permutation, ie, the location where p[i] > p[i+1]

Examples

@@ -1442,7 +1442,7 @@
Documentation Version
-classmethod from_inversion_vector(inversion)[source]
+classmethod from_inversion_vector(inversion)[source]

Calculates the permutation from the inversion vector.

Examples

>>> from sympy.combinatorics import Permutation
@@ -1456,7 +1456,7 @@ 
Documentation Version
-classmethod from_sequence(i, key=None)[source]
+classmethod from_sequence(i, key=None)[source]

Return the permutation needed to obtain i from the sorted elements of i. If custom sorting is desired, a key can be given.

Examples

@@ -1487,7 +1487,7 @@
Documentation Version
-get_adjacency_distance(other)[source]
+get_adjacency_distance(other)[source]

Computes the adjacency distance between two permutations.

Explanation

This metric counts the number of times a pair i,j of jobs is @@ -1514,7 +1514,7 @@

Documentation Version
-get_adjacency_matrix()[source]
+get_adjacency_matrix()[source]

Computes the adjacency matrix of a permutation.

Explanation

If job i is adjacent to job j in a permutation p @@ -1548,7 +1548,7 @@

Documentation Version
-get_positional_distance(other)[source]
+get_positional_distance(other)[source]

Computes the positional distance between two permutations.

Examples

>>> from sympy.combinatorics import Permutation
@@ -1569,7 +1569,7 @@ 
Documentation Version
-get_precedence_distance(other)[source]
+get_precedence_distance(other)[source]

Computes the precedence distance between two permutations.

Explanation

Suppose p and p’ represent n jobs. The precedence metric @@ -1593,7 +1593,7 @@

Documentation Version
-get_precedence_matrix()[source]
+get_precedence_matrix()[source]

Gets the precedence matrix. This is used for computing the distance between two permutations.

Examples

@@ -1621,7 +1621,7 @@
Documentation Version
-index()[source]
+index()[source]

Returns the index of a permutation.

The index of a permutation is the sum of all subscripts j such that p[j] is greater than p[j+1].

@@ -1636,7 +1636,7 @@
Documentation Version
-inversion_vector()[source]
+inversion_vector()[source]

Return the inversion vector of the permutation.

The inversion vector consists of elements whose value indicates the number of elements in the permutation @@ -1675,7 +1675,7 @@

Documentation Version
-inversions()[source]
+inversions()[source]

Computes the number of inversions of a permutation.

Explanation

An inversion is where i > j but p[i] < p[j].

@@ -1810,7 +1810,7 @@
Documentation Version
-classmethod josephus(m, n, s=1)[source]
+classmethod josephus(m, n, s=1)[source]

Return as a permutation the shuffling of range(n) using the Josephus scheme in which every m-th item is selected until all have been chosen. The returned permutation has elements listed by the order in which they @@ -1855,7 +1855,7 @@

Documentation Version
-length()[source]
+length()[source]

Returns the number of integers moved by a permutation.

Examples

>>> from sympy.combinatorics import Permutation
@@ -1873,7 +1873,7 @@ 
Documentation Version
-list(size=None)[source]
+list(size=None)[source]

Return the permutation as an explicit list, possibly trimming unmoved elements if size is less than the maximum element in the permutation; if this is desired, setting @@ -1899,7 +1899,7 @@

Documentation Version
-max() int[source]
+max() int[source]

The maximum element moved by the permutation.

Examples

>>> from sympy.combinatorics import Permutation
@@ -1916,7 +1916,7 @@ 
Documentation Version
-min() int[source]
+min() int[source]

The minimum element moved by the permutation.

Examples

>>> from sympy.combinatorics import Permutation
@@ -1933,13 +1933,13 @@ 
Documentation Version
-mul_inv(other)[source]
+mul_inv(other)[source]

other*~self, self and other have _array_form

-next_lex()[source]
+next_lex()[source]

Returns the next permutation in lexicographical order. If self is the last permutation in lexicographical order it returns None. @@ -1961,7 +1961,7 @@

Documentation Version
-next_nonlex()[source]
+next_nonlex()[source]

Returns the next permutation in nonlex order [3]. If self is the last permutation in this order it returns None.

Examples

@@ -1984,7 +1984,7 @@
Documentation Version
-next_trotterjohnson()[source]
+next_trotterjohnson()[source]

Returns the next permutation in Trotter-Johnson order. If self is the last permutation it returns None. See [4] section 2.4. If it is desired to generate all such @@ -2011,7 +2011,7 @@

Documentation Version
-order()[source]
+order()[source]

Computes the order of a permutation.

When the permutation is raised to the power of its order it equals the identity permutation.

@@ -2034,7 +2034,7 @@
Documentation Version
-parity()[source]
+parity()[source]

Computes the parity of a permutation.

Explanation

The parity of a permutation reflects the parity of the @@ -2058,7 +2058,7 @@

Documentation Version
-classmethod random(n)[source]
+classmethod random(n)[source]

Generates a random permutation of length n.

Uses the underlying Python pseudo-random number generator.

Examples

@@ -2071,7 +2071,7 @@
Documentation Version
-rank()[source]
+rank()[source]

Returns the lexicographic rank of the permutation.

Examples

>>> from sympy.combinatorics import Permutation
@@ -2091,7 +2091,7 @@ 
Documentation Version
-rank_nonlex(inv_perm=None)[source]
+rank_nonlex(inv_perm=None)[source]

This is a linear time ranking algorithm that does not enforce lexicographic order [3].

Examples

@@ -2109,7 +2109,7 @@
Documentation Version
-rank_trotterjohnson()[source]
+rank_trotterjohnson()[source]

Returns the Trotter Johnson rank, which we get from the minimal change algorithm. See [4] section 2.4.

Examples

@@ -2130,7 +2130,7 @@
Documentation Version
-resize(n)[source]
+resize(n)[source]

Resize the permutation to the new size n.

Parameters:
@@ -2177,7 +2177,7 @@
Documentation Version
-static rmul(*args)[source]
+static rmul(*args)[source]

Return product of Permutations [a, b, c, …] as the Permutation whose ith value is a(b(c(i))).

a, b, c, … can be Permutation objects or tuples.

@@ -2213,14 +2213,14 @@
Documentation Version
-classmethod rmul_with_af(*args)[source]
+classmethod rmul_with_af(*args)[source]

same as rmul, but the elements of args are Permutation objects which have _array_form

-runs()[source]
+runs()[source]

Returns the runs of a permutation.

An ascending sequence in a permutation is called a run [5].

Examples

@@ -2237,7 +2237,7 @@
Documentation Version
-signature()[source]
+signature()[source]

Gives the signature of the permutation needed to place the elements of the permutation in canonical order.

The signature is calculated as (-1)^<number of inversions>

@@ -2279,7 +2279,7 @@
Documentation Version
-support()[source]
+support()[source]

Return the elements in permutation, P, for which P[i] != i.

Examples

>>> from sympy.combinatorics import Permutation
@@ -2294,7 +2294,7 @@ 
Documentation Version
-transpositions()[source]
+transpositions()[source]

Return the permutation decomposed into a list of transpositions.

Explanation

It is always possible to express a permutation as the product of @@ -2322,7 +2322,7 @@

Documentation Version
-classmethod unrank_lex(size, rank)[source]
+classmethod unrank_lex(size, rank)[source]

Lexicographic permutation unranking.

Examples

>>> from sympy.combinatorics import Permutation
@@ -2343,7 +2343,7 @@ 
Documentation Version
-classmethod unrank_nonlex(n, r)[source]
+classmethod unrank_nonlex(n, r)[source]

This is a linear time unranking algorithm that does not respect lexicographic order [3].

Examples

@@ -2364,7 +2364,7 @@
Documentation Version
-classmethod unrank_trotterjohnson(size, rank)[source]
+classmethod unrank_trotterjohnson(size, rank)[source]

Trotter Johnson permutation unranking. See [4] section 2.4.

Examples

>>> from sympy.combinatorics import Permutation
@@ -2384,7 +2384,7 @@ 
Documentation Version
-class sympy.combinatorics.permutations.Cycle(*args)[source]
+class sympy.combinatorics.permutations.Cycle(*args)[source]

Wrapper around dict which provides the functionality of a disjoint cycle.

Explanation

A cycle shows the rule to use to move subsets of elements to obtain @@ -2455,7 +2455,7 @@

Documentation Version
-list(size=None)[source]
+list(size=None)[source]

Return the cycles as an explicit list starting from 0 up to the greater of the largest value in the cycles and size.

Truncation of trailing unmoved items will occur when size @@ -2482,7 +2482,7 @@

Documentation Version
-sympy.combinatorics.permutations._af_parity(pi)[source]
+sympy.combinatorics.permutations._af_parity(pi)[source]

Computes the parity of a permutation in array form.

Explanation

The parity of a permutation reflects the parity of the @@ -2506,7 +2506,7 @@

Documentation Version

Generators

-generators.symmetric()[source]
+generators.symmetric()[source]

Generates the symmetric group of order n, Sn.

Examples

>>> from sympy.combinatorics.generators import symmetric
@@ -2518,7 +2518,7 @@ 
Documentation Version
-generators.cyclic()[source]
+generators.cyclic()[source]

Generates the cyclic group of order n, Cn.

Examples

>>> from sympy.combinatorics.generators import cyclic
@@ -2535,7 +2535,7 @@ 
Documentation Version
-generators.alternating()[source]
+generators.alternating()[source]

Generates the alternating group of order n, An.

Examples

>>> from sympy.combinatorics.generators import alternating
@@ -2547,7 +2547,7 @@ 
Documentation Version
-generators.dihedral()[source]
+generators.dihedral()[source]

Generates the dihedral group of order 2n, Dn.

The result is given as a subgroup of Sn, except for the special cases n=1 (the group S2) and n=2 (the Klein 4-group) where that’s not possible diff --git a/dev/modules/combinatorics/polyhedron.html b/dev/modules/combinatorics/polyhedron.html index 25d8a2a7650..4503ebd82dd 100644 --- a/dev/modules/combinatorics/polyhedron.html +++ b/dev/modules/combinatorics/polyhedron.html @@ -805,7 +805,7 @@

Documentation Version

Polyhedron

-class sympy.combinatorics.polyhedron.Polyhedron(corners, faces=(), pgroup=())[source]
+class sympy.combinatorics.polyhedron.Polyhedron(corners, faces=(), pgroup=())[source]

Represents the polyhedral symmetry group (PSG).

Explanation

The PSG is one of the symmetry groups of the Platonic solids. @@ -905,7 +905,7 @@

Documentation Version
-reset()[source]
+reset()[source]

Return corners to their original positions.

Examples

>>> from sympy.combinatorics.polyhedron import tetrahedron as T
@@ -924,7 +924,7 @@ 
Documentation Version
-rotate(perm)[source]
+rotate(perm)[source]

Apply a permutation to the polyhedron in place. The permutation may be given as a Permutation instance or an integer indicating which permutation from pgroup of the Polyhedron should be diff --git a/dev/modules/combinatorics/prufer.html b/dev/modules/combinatorics/prufer.html index c1d721872e4..71d3bcbf8d2 100644 --- a/dev/modules/combinatorics/prufer.html +++ b/dev/modules/combinatorics/prufer.html @@ -805,7 +805,7 @@

Documentation Version

Prufer Sequences

-class sympy.combinatorics.prufer.Prufer(*args, **kw_args)[source]
+class sympy.combinatorics.prufer.Prufer(*args, **kw_args)[source]

The Prufer correspondence is an algorithm that describes the bijection between labeled trees and the Prufer code. A Prufer code of a labeled tree is unique up to isomorphism and has @@ -821,7 +821,7 @@

Documentation Version
-static edges(*runs)[source]
+static edges(*runs)[source]

Return a list of edges and the number of nodes from the given runs that connect nodes in an integer-labelled tree.

All node numbers will be shifted so that the minimum node is 0. It is @@ -844,7 +844,7 @@

Documentation Version
-next(delta=1)[source]
+next(delta=1)[source]

Generates the Prufer sequence that is delta beyond the current one.

Examples

>>> from sympy.combinatorics.prufer import Prufer
@@ -878,7 +878,7 @@ 
Documentation Version
-prev(delta=1)[source]
+prev(delta=1)[source]

Generates the Prufer sequence that is -delta before the current one.

Examples

>>> from sympy.combinatorics.prufer import Prufer
@@ -900,7 +900,7 @@ 
Documentation Version
-prufer_rank()[source]
+prufer_rank()[source]

Computes the rank of a Prufer sequence.

Examples

>>> from sympy.combinatorics.prufer import Prufer
@@ -975,7 +975,7 @@ 
Documentation Version
-static to_prufer(tree, n)[source]
+static to_prufer(tree, n)[source]

Return the Prufer sequence for a tree given as a list of edges where n is the number of nodes in the tree.

Examples

@@ -998,7 +998,7 @@
Documentation Version
-static to_tree(prufer)[source]
+static to_tree(prufer)[source]

Return the tree (as a list of edges) of the given Prufer sequence.

Examples

>>> from sympy.combinatorics.prufer import Prufer
@@ -1045,7 +1045,7 @@ 
Documentation Version
-classmethod unrank(rank, n)[source]
+classmethod unrank(rank, n)[source]

Finds the unranked Prufer sequence.

Examples

>>> from sympy.combinatorics.prufer import Prufer
diff --git a/dev/modules/combinatorics/subsets.html b/dev/modules/combinatorics/subsets.html
index 014d881ce47..7fc04d8b2e5 100644
--- a/dev/modules/combinatorics/subsets.html
+++ b/dev/modules/combinatorics/subsets.html
@@ -805,7 +805,7 @@ 
Documentation Version

Subsets

-class sympy.combinatorics.subsets.Subset(subset, superset)[source]
+class sympy.combinatorics.subsets.Subset(subset, superset)[source]

Represents a basic subset object.

Explanation

We generate subsets using essentially two techniques, @@ -824,7 +824,7 @@

Documentation Version
-classmethod bitlist_from_subset(subset, superset)[source]
+classmethod bitlist_from_subset(subset, superset)[source]

Gets the bitlist corresponding to a subset.

Examples

>>> from sympy.combinatorics import Subset
@@ -857,7 +857,7 @@ 
Documentation Version
-iterate_binary(k)[source]
+iterate_binary(k)[source]

This is a helper function. It iterates over the binary subsets by k steps. This variable can be both positive or negative.

@@ -879,7 +879,7 @@
Documentation Version
-iterate_graycode(k)[source]
+iterate_graycode(k)[source]

Helper function used for prev_gray and next_gray. It performs k step overs to get the respective Gray codes.

Examples

@@ -899,7 +899,7 @@
Documentation Version
-next_binary()[source]
+next_binary()[source]

Generates the next binary ordered subset.

Examples

>>> from sympy.combinatorics import Subset
@@ -919,7 +919,7 @@ 
Documentation Version
-next_gray()[source]
+next_gray()[source]

Generates the next Gray code ordered subset.

Examples

>>> from sympy.combinatorics import Subset
@@ -936,7 +936,7 @@ 
Documentation Version
-next_lexicographic()[source]
+next_lexicographic()[source]

Generates the next lexicographically ordered subset.

Examples

>>> from sympy.combinatorics import Subset
@@ -956,7 +956,7 @@ 
Documentation Version
-prev_binary()[source]
+prev_binary()[source]

Generates the previous binary ordered subset.

Examples

>>> from sympy.combinatorics import Subset
@@ -976,7 +976,7 @@ 
Documentation Version
-prev_gray()[source]
+prev_gray()[source]

Generates the previous Gray code ordered subset.

Examples

>>> from sympy.combinatorics import Subset
@@ -993,7 +993,7 @@ 
Documentation Version
-prev_lexicographic()[source]
+prev_lexicographic()[source]

Generates the previous lexicographically ordered subset.

Examples

>>> from sympy.combinatorics import Subset
@@ -1103,7 +1103,7 @@ 
Documentation Version
-classmethod subset_from_bitlist(super_set, bitlist)[source]
+classmethod subset_from_bitlist(super_set, bitlist)[source]

Gets the subset defined by the bitlist.

Examples

>>> from sympy.combinatorics import Subset
@@ -1119,7 +1119,7 @@ 
Documentation Version
-classmethod subset_indices(subset, superset)[source]
+classmethod subset_indices(subset, superset)[source]

Return indices of subset in superset in a list; the list is empty if all elements of subset are not in superset.

Examples

@@ -1171,7 +1171,7 @@
Documentation Version
-classmethod unrank_binary(rank, superset)[source]
+classmethod unrank_binary(rank, superset)[source]

Gets the binary ordered subset of the specified rank.

Examples

>>> from sympy.combinatorics import Subset
@@ -1187,7 +1187,7 @@ 
Documentation Version
-classmethod unrank_gray(rank, superset)[source]
+classmethod unrank_gray(rank, superset)[source]

Gets the Gray code ordered subset of the specified rank.

Examples

>>> from sympy.combinatorics import Subset
@@ -1207,7 +1207,7 @@ 
Documentation Version
-subsets.ksubsets(k)[source]
+subsets.ksubsets(k)[source]

Finds the subsets of size k in lexicographic order.

This uses the itertools generator.

Examples

diff --git a/dev/modules/combinatorics/tensor_can.html b/dev/modules/combinatorics/tensor_can.html index d176935e71d..668a93835d0 100644 --- a/dev/modules/combinatorics/tensor_can.html +++ b/dev/modules/combinatorics/tensor_can.html @@ -805,7 +805,7 @@
Documentation Version

Tensor Canonicalization

-sympy.combinatorics.tensor_can.canonicalize(g, dummies, msym, *v)[source]
+sympy.combinatorics.tensor_can.canonicalize(g, dummies, msym, *v)[source]

canonicalize tensor formed by tensors

Parameters:
@@ -924,7 +924,7 @@
Documentation Version
g,
-)[source] +)[source]

Butler-Portugal algorithm for tensor canonicalization with dummy indices.

Parameters:
@@ -1116,7 +1116,7 @@
Documentation Version
-sympy.combinatorics.tensor_can.get_symmetric_group_sgs(n, antisym=False)[source]
+sympy.combinatorics.tensor_can.get_symmetric_group_sgs(n, antisym=False)[source]

Return base, gens of the minimal BSGS for (anti)symmetric tensor

Parameters:
@@ -1148,7 +1148,7 @@
Documentation Version
signed=True,
-)[source] +)[source]

Direct product of two BSGS.

Parameters:
diff --git a/dev/modules/combinatorics/testutil.html b/dev/modules/combinatorics/testutil.html index 8b440de9ad7..ec9752a9733 100644 --- a/dev/modules/combinatorics/testutil.html +++ b/dev/modules/combinatorics/testutil.html @@ -805,7 +805,7 @@
Documentation Version

Test Utilities

-sympy.combinatorics.testutil._cmp_perm_lists(first, second)[source]
+sympy.combinatorics.testutil._cmp_perm_lists(first, second)[source]

Compare two lists of permutations as sets.

Explanation

This is used for testing purposes. Since the array form of a @@ -827,12 +827,12 @@

Documentation Version
-sympy.combinatorics.testutil._naive_list_centralizer(self, other, af=False)[source]
+sympy.combinatorics.testutil._naive_list_centralizer(self, other, af=False)[source]
-sympy.combinatorics.testutil._verify_bsgs(group, base, gens)[source]
+sympy.combinatorics.testutil._verify_bsgs(group, base, gens)[source]

Verify the correctness of a base and strong generating set.

Explanation

This is a naive implementation using the definition of a base and a strong @@ -856,7 +856,7 @@

Documentation Version
-sympy.combinatorics.testutil._verify_centralizer(group, arg, centr=None)[source]
+sympy.combinatorics.testutil._verify_centralizer(group, arg, centr=None)[source]

Verify the centralizer of a group/set/element inside another group.

This is used for testing .centralizer() from sympy.combinatorics.perm_groups

@@ -881,7 +881,7 @@
Documentation Version
-sympy.combinatorics.testutil._verify_normal_closure(group, arg, closure=None)[source]
+sympy.combinatorics.testutil._verify_normal_closure(group, arg, closure=None)[source]
diff --git a/dev/modules/combinatorics/util.html b/dev/modules/combinatorics/util.html index 396bbbe4ced..c630f7d0f3f 100644 --- a/dev/modules/combinatorics/util.html +++ b/dev/modules/combinatorics/util.html @@ -805,7 +805,7 @@
Documentation Version

Utilities

-sympy.combinatorics.util._base_ordering(base, degree)[source]
+sympy.combinatorics.util._base_ordering(base, degree)[source]

Order \(\{0, 1, \dots, n-1\}\) so that base points come first and in order.

Parameters:
@@ -846,7 +846,7 @@
Documentation Version
-sympy.combinatorics.util._check_cycles_alt_sym(perm)[source]
+sympy.combinatorics.util._check_cycles_alt_sym(perm)[source]

Checks for cycles of prime length p with n/2 < p < n-2.

Explanation

Here \(n\) is the degree of the permutation. This is a helper function for @@ -870,7 +870,7 @@

Documentation Version
-sympy.combinatorics.util._distribute_gens_by_base(base, gens)[source]
+sympy.combinatorics.util._distribute_gens_by_base(base, gens)[source]

Distribute the group elements gens by membership in basic stabilizers.

Parameters:
@@ -924,7 +924,7 @@
Documentation Version
strong_gens_distr=None,
-)[source] +)[source]

Calculate BSGS-related structures from those present.

Parameters:
@@ -974,7 +974,7 @@
Documentation Version
slp=False,
-)[source] +)[source]

Compute basic orbits and transversals from a base and strong generating set.

Parameters:
@@ -1025,7 +1025,7 @@
Documentation Version
strong_gens_distr=None,
-)[source] +)[source]

Remove redundant generators from a strong generating set.

Parameters:
@@ -1066,7 +1066,7 @@
Documentation Version
-sympy.combinatorics.util._strip(g, base, orbits, transversals)[source]
+sympy.combinatorics.util._strip(g, base, orbits, transversals)[source]

Attempt to decompose a permutation using a (possibly partial) BSGS structure.

@@ -1126,7 +1126,7 @@
Documentation Version
-sympy.combinatorics.util._strong_gens_from_distr(strong_gens_distr)[source]
+sympy.combinatorics.util._strong_gens_from_distr(strong_gens_distr)[source]

Retrieve strong generating set from generators of basic stabilizers.

This is just the union of the generators of the first and second basic stabilizers.

diff --git a/dev/modules/concrete.html b/dev/modules/concrete.html index 616d62b1a58..f95a2daafe7 100644 --- a/dev/modules/concrete.html +++ b/dev/modules/concrete.html @@ -883,7 +883,7 @@

Hypergeometric termsConcrete Class Reference

-class sympy.concrete.summations.Sum(function, *symbols, **assumptions)[source]
+class sympy.concrete.summations.Sum(function, *symbols, **assumptions)[source]

Represents unevaluated summation.

Explanation

Sum represents a finite or infinite series, with the first argument @@ -1018,7 +1018,7 @@

Concrete Class Referenceeval_integral=True,

-)[source] +)[source]

Return an Euler-Maclaurin approximation of self, where m is the number of leading terms to sum directly and n is the number of terms in the tail.

@@ -1061,7 +1061,7 @@

Concrete Class Reference
-eval_zeta_function(f, limits)[source]
+eval_zeta_function(f, limits)[source]

Check whether the function matches with the zeta function.

If it matches, then return a \(Piecewise\) expression because zeta function does not converge unless \(s > 1\) and \(q > 0\)

@@ -1069,7 +1069,7 @@

Concrete Class Reference
-is_absolutely_convergent()[source]
+is_absolutely_convergent()[source]

Checks for the absolute convergence of an infinite series.

Same as checking convergence of absolute value of sequence_term of an infinite series.

@@ -1097,7 +1097,7 @@

Concrete Class Reference
-is_convergent()[source]
+is_convergent()[source]

Checks for the convergence of a Sum.

Explanation

We divide the study of convergence of infinite sums and products in @@ -1162,7 +1162,7 @@

Concrete Class Reference
-reverse_order(*indices)[source]
+reverse_order(*indices)[source]

Reverse the order of a limit in a Sum.

Explanation

reverse_order(self, *indices) reverses some limits in the expression @@ -1225,7 +1225,7 @@

Concrete Class Reference
-class sympy.concrete.products.Product(function, *symbols, **assumptions)[source]
+class sympy.concrete.products.Product(function, *symbols, **assumptions)[source]

Represents unevaluated products.

Explanation

Product represents a finite or infinite product, with the first @@ -1393,7 +1393,7 @@

Concrete Class Reference
-is_convergent()[source]
+is_convergent()[source]

See docs of Sum.is_convergent() for explanation of convergence in SymPy.

Explanation

@@ -1438,7 +1438,7 @@

Concrete Class Reference
-reverse_order(*indices)[source]
+reverse_order(*indices)[source]

Reverse the order of a limit in a Product.

Explanation

reverse_order(expr, *indices) reverses some limits in the expression @@ -1513,7 +1513,7 @@

Concrete Class Reference**assumptions,

-)[source] +)[source]

Superclass for Product and Sum.

See also

@@ -1529,7 +1529,7 @@

Concrete Class Referencenewvar=None,

-)[source] +)[source]

Change index of a Sum or Product.

Perform a linear transformation \(x \mapsto a x + b\) on the index variable \(x\). For \(a\) the only values allowed are \(\pm 1\). A new variable to be used @@ -1657,7 +1657,7 @@

Concrete Class Reference
-index(x)[source]
+index(x)[source]

Return the index of a dummy variable in the list of limits.

Explanation

index(expr, x) returns the index of the dummy variable x in the @@ -1684,7 +1684,7 @@

Concrete Class Reference
-reorder(*arg)[source]
+reorder(*arg)[source]

Reorder limits in a expression containing a Sum or a Product.

Explanation

expr.reorder(*arg) reorders the limits in the expression expr @@ -1729,7 +1729,7 @@

Concrete Class Reference
-reorder_limit(x, y)[source]
+reorder_limit(x, y)[source]

Interchange two limit tuples of a Sum or Product expression.

Explanation

expr.reorder_limit(x, y) interchanges two limit tuples. The @@ -1764,7 +1764,7 @@

Concrete Class Reference

-sympy.concrete.summations.summation(f, *symbols, **kwargs)[source]
+sympy.concrete.summations.summation(f, *symbols, **kwargs)[source]

Compute the summation of f with respect to symbols.

Explanation

The notation for symbols is similar to the notation used in Integral. @@ -1811,7 +1811,7 @@

Concrete Functions Reference
-sympy.concrete.products.product(*args, **kwargs)[source]
+sympy.concrete.products.product(*args, **kwargs)[source]

Compute the product.

Explanation

The notation for symbols is similar to the notation used in Sum or @@ -1845,7 +1845,7 @@

Concrete Functions Reference
-sympy.concrete.gosper.gosper_normal(f, g, n, polys=True)[source]
+sympy.concrete.gosper.gosper_normal(f, g, n, polys=True)[source]

Compute the Gosper’s normal form of f and g.

Explanation

Given relatively prime univariate polynomials f and g, @@ -1880,7 +1880,7 @@

Concrete Functions Reference
-sympy.concrete.gosper.gosper_term(f, n)[source]
+sympy.concrete.gosper.gosper_term(f, n)[source]

Compute Gosper’s hypergeometric term for f.

Explanation

Suppose f is a hypergeometric term such that:

@@ -1904,7 +1904,7 @@

Concrete Functions Reference
-sympy.concrete.gosper.gosper_sum(f, k)[source]
+sympy.concrete.gosper.gosper_sum(f, k)[source]

Gosper’s hypergeometric summation algorithm.

Explanation

Given a hypergeometric term f such that:

diff --git a/dev/modules/core.html b/dev/modules/core.html index f54f79045a7..7a724a599a3 100644 --- a/dev/modules/core.html +++ b/dev/modules/core.html @@ -818,7 +818,7 @@
Documentation Version
evaluate=None,

-)[source] +)[source]

Converts an arbitrary expression to a type that can be used inside SymPy.

Parameters:
@@ -1299,7 +1299,7 @@

References

cache

-sympy.core.cache.__cacheit(maxsize)[source]
+sympy.core.cache.__cacheit(maxsize)[source]

caching decorator.

important: the result of cached function must be immutable

Examples

@@ -1323,7 +1323,7 @@

References

basic

-class sympy.core.basic.Basic(*args)[source]
+class sympy.core.basic.Basic(*args)[source]

Base class for all SymPy objects.

Notes And Conventions

    @@ -1414,7 +1414,7 @@

    Referencesclear=True,

-)[source] +)[source]

A stub to allow Basic args (like Tuple) to be skipped when computing the content and primitive components of an expression.

@@ -1425,7 +1425,7 @@

References
-as_dummy() Self[source]
+as_dummy() Self[source]

Return the expression with any objects having structurally bound symbols replaced with unique, canonical symbols within the object in which they appear and having only the default @@ -1481,7 +1481,7 @@

References
-atoms(*types)[source]
+atoms(*types)[source]

Returns the atoms that form the current object.

By default, only objects that are truly atomic and cannot be divided into smaller pieces are returned: symbols, numbers, @@ -1569,13 +1569,13 @@

References
-classmethod class_key() tuple[int, int, str][source]
+classmethod class_key() tuple[int, int, str][source]

Nice order of classes.

-compare(other)[source]
+compare(other)[source]

Return -1, 0, 1 if the object is less than, equal, or greater than other in a canonical sense. Non-Basic are always greater than Basic. @@ -1603,19 +1603,19 @@

References
-count(query)[source]
+count(query)[source]

Count the number of matching subexpressions.

-count_ops(visual=False)[source]
+count_ops(visual=False)[source]

Wrapper for count_ops that returns the operation count.

-doit(**hints)[source]
+doit(**hints)[source]

Evaluate objects that are not evaluated by default like limits, integrals, sums and products. All objects of this kind will be evaluated recursively, unless some species were excluded via ‘hints’ @@ -1640,7 +1640,7 @@

References
-dummy_eq(other, symbol=None)[source]
+dummy_eq(other, symbol=None)[source]

Compare two expressions and handle dummy symbols.

Examples

>>> from sympy import Dummy
@@ -1666,7 +1666,7 @@ 

References
-find(query, group=False)[source]
+find(query, group=False)[source]

Find all subexpressions matching a query.

@@ -1717,7 +1717,7 @@

References
-classmethod fromiter(args, **assumptions)[source]
+classmethod fromiter(args, **assumptions)[source]

Create a new object from an iterable.

This is a convenience function that allows one to create objects from any iterable, without having to convert to a list or tuple first.

@@ -1754,7 +1754,7 @@

References
-has(*patterns)[source]
+has(*patterns)[source]

Test whether any subexpression matches any of the patterns.

Examples

>>> from sympy import sin
@@ -1799,7 +1799,7 @@ 

References
-has_free(*patterns)[source]
+has_free(*patterns)[source]

Return True if self has object(s) x as a free expression else False.

Examples

@@ -1827,7 +1827,7 @@

References
-has_xfree(s: set[Basic])[source]
+has_xfree(s: set[Basic])[source]

Return True if self has any of the patterns in s as a free argument, else False. This is like \(Basic.has_free\) but this will only report exact argument matches.

@@ -1878,7 +1878,7 @@

References
-is_same(b, approx=None)[source]
+is_same(b, approx=None)[source]

Return True if a and b are structurally the same, else False. If \(approx\) is supplied, it will be used to test whether two numbers are the same or not. By default, only numbers of the @@ -1932,7 +1932,7 @@

References
-match(pattern, old=False)[source]
+match(pattern, old=False)[source]

Pattern matching.

Wild symbols match all.

Return None when expression (self) does not match with pattern. @@ -1996,7 +1996,7 @@

References
-matches(expr, repl_dict=None, old=False)[source]
+matches(expr, repl_dict=None, old=False)[source]

Helper method for match() that looks for a match between Wild symbols in self and expressions in expr.

Examples

@@ -2013,7 +2013,7 @@

References
-rcall(*args)[source]
+rcall(*args)[source]

Apply on the argument recursively through the expression tree.

This method is used to simulate a common abuse of notation for operators. For instance, in SymPy the following will not work:

@@ -2029,7 +2029,7 @@

References
-refine(assumption=True)[source]
+refine(assumption=True)[source]

See the refine function in sympy.assumptions

@@ -2045,7 +2045,7 @@

Referencesexact=None,

-) Basic[source] +) Basic[source]

Replace matching subexpressions of self with value.

If map = True then also return the mapping {old: new} where old was a sub-expression found with query and new is the replacement @@ -2199,7 +2199,7 @@

References
-rewrite(*args, deep=True, **hints)[source]
+rewrite(*args, deep=True, **hints)[source]

Rewrite self using a defined rule.

Rewriting transforms an expression to another, which is mathematically equivalent but structurally different. For example you can rewrite @@ -2273,13 +2273,13 @@

References
-simplify(**kwargs)[source]
+simplify(**kwargs)[source]

See the simplify function in sympy.simplify

-sort_key(order=None)[source]
+sort_key(order=None)[source]

Return a sort key.

Examples

>>> from sympy import S, I
@@ -2299,7 +2299,7 @@ 

References
-subs(*args, **kwargs)[source]
+subs(*args, **kwargs)[source]

Substitutes old for new in an expression after sympifying args.

\(args\) is either:
@@ -2691,7 +2691,7 @@

References*deps,

-) tuple[Expr, tuple[Expr, ...]][source] +) tuple[Expr, tuple[Expr, ...]][source]

Return the tuple (c, args) where self is written as an Add, a.

c should be a Rational added to any terms of the Add that are independent of deps.

@@ -2729,7 +2729,7 @@

Referencesx,

-) tuple[Expr, Expr][source] +) tuple[Expr, Expr][source]

c*x**e -> c,e where x can be any symbolic expression.

@@ -2742,7 +2742,7 @@

References**kwargs,

-) tuple[Expr, tuple[Expr, ...]][source] +) tuple[Expr, tuple[Expr, ...]][source]

Return the tuple (c, args) where self is written as a Mul, m.

c should be a Rational multiplied by any factors of the Mul that are independent of deps.

@@ -2774,7 +2774,7 @@

References
-as_coefficient(expr)[source]
+as_coefficient(expr)[source]

Extracts symbolic coefficient at the given expression. In other words, this functions separates ‘self’ into the product of ‘expr’ and ‘expr’-free coefficient. If such separation @@ -2846,7 +2846,7 @@

References
-as_coefficients_dict(*syms)[source]
+as_coefficients_dict(*syms)[source]

Return a dictionary mapping terms to their Rational coefficient. Since the dictionary is a defaultdict, inquiries about terms which were not present will return a coefficient of 0.

@@ -2879,7 +2879,7 @@

Referencesclear=True,

-)[source] +)[source]

This method should recursively remove a Rational from all arguments and return that (content) and the new self (primitive). The content should always be positive and Mul(*foo.as_content_primitive()) == foo. @@ -2937,7 +2937,7 @@

References
-as_expr(*gens)[source]
+as_expr(*gens)[source]

Convert a polynomial to a SymPy expression.

Examples

>>> from sympy import sin
@@ -2964,7 +2964,7 @@ 

References**hint,

-) tuple[Expr, Expr][source] +) tuple[Expr, Expr][source]

A mostly naive separation of a Mul or Add into arguments that are not are dependent on deps. To obtain as complete a separation of variables as possible, use a separation method first, e.g.:

@@ -3095,7 +3095,7 @@

References
-as_leading_term(*symbols, logx=None, cdir=0)[source]
+as_leading_term(*symbols, logx=None, cdir=0)[source]

Returns the leading (nonzero) term of the series expansion of self.

The _eval_as_leading_term routines are used to do this, and they must always return a non-zero value.

@@ -3111,7 +3111,7 @@

References
-as_numer_denom()[source]
+as_numer_denom()[source]

Return the numerator and the denominator of an expression.

expression -> a/b -> a, b

This is just a stub that should be defined by @@ -3127,13 +3127,13 @@

References
-as_ordered_factors(order=None)[source]
+as_ordered_factors(order=None)[source]

Return list of ordered factors (if Mul) else [self].

-as_ordered_terms(order=None, data=False)[source]
+as_ordered_terms(order=None, data=False)[source]

Transform an expression to an ordered list of terms.

Examples

>>> from sympy import sin, cos
@@ -3148,7 +3148,7 @@ 

References
-as_poly(*gens, **args)[source]
+as_poly(*gens, **args)[source]

Converts self to a polynomial or returns None.

Explanation

>>> from sympy import sin
@@ -3171,7 +3171,7 @@ 

References
-as_powers_dict()[source]
+as_powers_dict()[source]

Return self as a dictionary of factors with each factor being treated as a power. The keys are the bases of the factors and the values, the corresponding exponents. The resulting dictionary should @@ -3191,7 +3191,7 @@

References
-as_real_imag(deep=True, **hints)[source]
+as_real_imag(deep=True, **hints)[source]

Performs complex expansion on ‘self’ and returns a tuple containing collected both real and imaginary parts. This method cannot be confused with re() and im() functions, @@ -3220,13 +3220,13 @@

References
-as_terms()[source]
+as_terms()[source]

Transform an expression to a list of terms.

-aseries(x=None, n=6, bound=0, hir=False)[source]
+aseries(x=None, n=6, bound=0, hir=False)[source]

Asymptotic Series expansion of self. This is equivalent to self.series(x, oo, n).

@@ -3332,13 +3332,13 @@

References
-cancel(*gens, **args)[source]
+cancel(*gens, **args)[source]

See the cancel function in sympy.polys

-coeff(x, n=1, right=False, _first=True)[source]
+coeff(x, n=1, right=False, _first=True)[source]

Returns the coefficient from the term(s) containing x**n. If n is zero then all terms independent of x will be returned.

Explanation

@@ -3466,19 +3466,19 @@

Referencesdistribute_order_term=True,

-)[source] +)[source]

See the collect function in sympy.simplify

-combsimp()[source]
+combsimp()[source]

See the combsimp function in sympy.simplify

-compute_leading_term(x, logx=None)[source]
+compute_leading_term(x, logx=None)[source]

Deprecated function to compute the leading term of a series.

as_leading_term is only allowed for results of .series() This is a wrapper to compute a series first.

@@ -3486,13 +3486,13 @@

References
-conjugate()[source]
+conjugate()[source]

Returns the complex conjugate of ‘self’.

-could_extract_minus_sign()[source]
+could_extract_minus_sign()[source]

Return True if self has -1 as a leading factor or has more literal negative signs than positive signs in a sum, otherwise False.

@@ -3522,7 +3522,7 @@

References
-equals(other, failing_expression=False)[source]
+equals(other, failing_expression=False)[source]

Return True if self == other, False if it does not, or None. If failing_expression is True then the expression which did not simplify to a 0 will be returned instead of None.

@@ -3552,7 +3552,7 @@

References**hints,

-)[source] +)[source]

Expand an expression using hints.

See the docstring of the expand() function in sympy.core.function for more information.

@@ -3583,7 +3583,7 @@

References
-extract_additively(c)[source]
+extract_additively(c)[source]

Return self - c if it’s possible to subtract c from self and make all matching coefficients move towards zero, else return None.

Examples

@@ -3606,7 +3606,7 @@

References
-extract_branch_factor(allow_half=False)[source]
+extract_branch_factor(allow_half=False)[source]

Try to write self as exp_polar(2*pi*I*n)*z in a nice way. Return (z, n).

>>> from sympy import exp_polar, I, pi
@@ -3640,7 +3640,7 @@ 

References
-extract_multiplicatively(c)[source]
+extract_multiplicatively(c)[source]

Return None if it’s not possible to make self in the form c * something in a nice way, i.e. preserving the properties of arguments of self.

@@ -3673,13 +3673,13 @@

References
-factor(*gens, **args)[source]
+factor(*gens, **args)[source]

See the factor() function in sympy.polys.polytools

-fourier_series(limits=None)[source]
+fourier_series(limits=None)[source]

Compute fourier sine/cosine series of self.

See the docstring of the fourier_series() in sympy.series.fourier for more information.

@@ -3699,7 +3699,7 @@

Referencesfull=False,

-)[source] +)[source]

Compute formal power power series of self.

See the docstring of the fps() function in sympy.series.formal for more information.

@@ -3707,19 +3707,19 @@

References
-gammasimp()[source]
+gammasimp()[source]

See the gammasimp function in sympy.simplify

-getO()[source]
+getO()[source]

Returns the additive O(..) symbol if there is one, else None.

-getn()[source]
+getn()[source]

Returns the order of the expression.

Explanation

The order is determined either from the O(…) term. If there @@ -3736,13 +3736,13 @@

References
-integrate(*args, **kwargs)[source]
+integrate(*args, **kwargs)[source]

See the integrate function in sympy.integrals

-invert(g, *gens, **args)[source]
+invert(g, *gens, **args)[source]

Return the multiplicative inverse of self mod g where self (and g) may be symbolic expressions).

@@ -3753,7 +3753,7 @@

References
-is_algebraic_expr(*syms)[source]
+is_algebraic_expr(*syms)[source]

This tests whether a given expression is algebraic or not, in the given symbols, syms. When syms is not given, all free symbols will be used. The rational function does not have to be in expanded @@ -3796,7 +3796,7 @@

References
-is_constant(*wrt, **flags)[source]
+is_constant(*wrt, **flags)[source]

Return True if self is constant, False if not, or None if the constancy could not be determined conclusively.

Explanation

@@ -3865,7 +3865,7 @@

References
-is_meromorphic(x, a)[source]
+is_meromorphic(x, a)[source]

This tests whether an expression is meromorphic as a function of the given symbol x at the point a.

This method is intended as a quick test that will return @@ -3974,7 +3974,7 @@

References
-is_polynomial(*syms)[source]
+is_polynomial(*syms)[source]

Return True if self is a polynomial in syms and False otherwise.

This checks if self is an exact polynomial in syms. This function returns False for expressions that are “polynomials” with symbolic @@ -4038,7 +4038,7 @@

References
-is_rational_function(*syms)[source]
+is_rational_function(*syms)[source]

Test whether function is a ratio of two polynomials in the given symbols, syms. When syms is not given, all free symbols will be used. The rational function does not have to be in expanded or in any kind of @@ -4090,7 +4090,7 @@

References
-leadterm(x, logx=None, cdir=0)[source]
+leadterm(x, logx=None, cdir=0)[source]

Returns the leading term a*x**b as a tuple (a, b).

Examples

>>> from sympy.abc import x
@@ -4104,7 +4104,7 @@ 

References
-limit(x, xlim, dir='+')[source]
+limit(x, xlim, dir='+')[source]

Compute limit x->xlim.

@@ -4120,7 +4120,7 @@

Referencescdir=0,

-)[source] +)[source]

Wrapper for series yielding an iterator of the terms of the series.

Note: an infinite series will yield an infinite iterator. The following, for exaxmple, will never terminate. It will just keep printing terms @@ -4138,7 +4138,7 @@

References
-normal()[source]
+normal()[source]

Return the expression as a fraction.

expression -> a/b

@@ -4163,7 +4163,7 @@

Referencescdir=0,

-)[source] +)[source]

Wrapper to _eval_nseries if assumptions allow, else to series.

If x is given, x0 is 0, dir=’+’, and self has x, then _eval_nseries is called. This calculates “n” terms in the innermost expressions and @@ -4225,19 +4225,19 @@

Referencesfull=False,

-)[source] +)[source]

See the nsimplify function in sympy.simplify

-powsimp(*args, **kwargs)[source]
+powsimp(*args, **kwargs)[source]

See the powsimp function in sympy.simplify

-primitive()[source]
+primitive()[source]

Return the positive Rational that can be extracted non-recursively from every term of self (i.e., self is treated like an Add). This is like the as_coeff_Mul() method but primitive always extracts a positive @@ -4258,25 +4258,25 @@

References
-radsimp(**kwargs)[source]
+radsimp(**kwargs)[source]

See the radsimp function in sympy.simplify

-ratsimp()[source]
+ratsimp()[source]

See the ratsimp function in sympy.simplify

-removeO()[source]
+removeO()[source]

Removes the additive O(..) symbol if there is one

-round(n=None)[source]
+round(n=None)[source]

Return x rounded to the given decimal place.

If a complex number would results, apply round to the real and imaginary components of the number.

@@ -4310,7 +4310,7 @@

References
-separate(deep=False, force=False)[source]
+separate(deep=False, force=False)[source]

See the separate function in sympy.simplify

@@ -4327,7 +4327,7 @@

Referencescdir=0,

-)[source] +)[source]

Series expansion of “self” around x = x0 yielding either terms of the series one by one (the lazy series given when n=None), else all the terms at once when n != None.

@@ -4440,7 +4440,7 @@

References
-taylor_term(n, x, *previous_terms)[source]
+taylor_term(n, x, *previous_terms)[source]

General method for the taylor term.

This method is slow, because it differentiates n-times. Subclasses can redefine it to make it faster by using the “previous_terms”.

@@ -4448,13 +4448,13 @@

References
-together(*args, **kwargs)[source]
+together(*args, **kwargs)[source]

See the together function in sympy.polys

-trigsimp(**args)[source]
+trigsimp(**args)[source]

See the trigsimp function in sympy.simplify

@@ -4462,7 +4462,7 @@

References
-class sympy.core.expr.UnevaluatedExpr(arg, **kwargs)[source]
+class sympy.core.expr.UnevaluatedExpr(arg, **kwargs)[source]

Expression that is not evaluated unless released.

Examples

>>> from sympy import UnevaluatedExpr
@@ -4477,7 +4477,7 @@ 

References
-class sympy.core.expr.AtomicExpr(*args)[source]
+class sympy.core.expr.AtomicExpr(*args)[source]

A parent class for object which are both atoms and Exprs.

For example: Symbol, Number, Rational, Integer, … But not: Add, Mul, Pow, …

@@ -4488,7 +4488,7 @@

References

symbol

-class sympy.core.symbol.Symbol(name, **assumptions)[source]
+class sympy.core.symbol.Symbol(name, **assumptions)[source]

Symbol class is used to create symbolic variables.

Parameters:
@@ -4544,7 +4544,7 @@

References**assumptions,

-)[source] +)[source]

A Wild symbol matches anything, or anything without whatever is explicitly excluded.

@@ -4635,7 +4635,7 @@

References
-class sympy.core.symbol.Dummy(name=None, dummy_index=None, **assumptions)[source]
+class sympy.core.symbol.Dummy(name=None, dummy_index=None, **assumptions)[source]

Dummy symbols are each unique, even if they have the same name:

Examples

>>> from sympy import Dummy
@@ -4663,7 +4663,7 @@ 

References**args,

-) Any[source] +) Any[source]

Transform strings into instances of Symbol class.

symbols() function returns a sequence of symbols with names taken from names argument, which can be a comma or whitespace delimited @@ -4780,7 +4780,7 @@

References
-sympy.core.symbol.var(names, **args)[source]
+sympy.core.symbol.var(names, **args)[source]

Create symbols and inject them into the global namespace.

Explanation

This calls symbols() with the same arguments and puts the results @@ -4819,7 +4819,7 @@

References

intfunc

-sympy.core.intfunc.num_digits(n, base=10)[source]
+sympy.core.intfunc.num_digits(n, base=10)[source]

Return the number of digits needed to express n in give base.

Parameters:
@@ -4851,7 +4851,7 @@

References
-sympy.core.intfunc.trailing(n)[source]
+sympy.core.intfunc.trailing(n)[source]

Count the number of trailing zero digits in the binary representation of n, i.e. determine the largest power of 2 that divides n.

@@ -4871,7 +4871,7 @@

References
-sympy.core.intfunc.ilcm(*args)[source]
+sympy.core.intfunc.ilcm(*args)[source]

Computes integer least common multiple.

Examples

>>> from sympy import ilcm
@@ -4913,7 +4913,7 @@ 

References
-sympy.core.intfunc.igcd_lehmer(a, b)[source]
+sympy.core.intfunc.igcd_lehmer(a, b)[source]

Computes greatest common divisor of two integers.

Explanation

Euclid’s algorithm for the computation of the greatest @@ -4956,7 +4956,7 @@

References
-sympy.core.intfunc.igcdex(a, b)[source]
+sympy.core.intfunc.igcdex(a, b)[source]

Returns x, y, g such that g = x*a + y*b = gcd(a, b).

Examples

>>> from sympy.core.intfunc import igcdex
@@ -4977,7 +4977,7 @@ 

References
-sympy.core.intfunc.isqrt(n)[source]
+sympy.core.intfunc.isqrt(n)[source]

Return the largest integer less than or equal to \(\sqrt{n}\).

Parameters:
@@ -5021,7 +5021,7 @@

References
-sympy.core.intfunc.integer_nthroot(y, n)[source]
+sympy.core.intfunc.integer_nthroot(y, n)[source]

Return a tuple containing x = floor(y**(1/n)) and a boolean indicating whether the result is exact (that is, whether x**n == y).

@@ -5048,7 +5048,7 @@

References
-sympy.core.intfunc.integer_log(n, b)[source]
+sympy.core.intfunc.integer_log(n, b)[source]

Returns (e, bool) where e is the largest nonnegative integer such that \(|n| \geq |b^e|\) and bool is True if \(n = b^e\).

Examples

@@ -5088,7 +5088,7 @@

References
-sympy.core.intfunc.mod_inverse(a, m)[source]
+sympy.core.intfunc.mod_inverse(a, m)[source]

Return the number \(c\) such that, \(a \times c = 1 \pmod{m}\) where \(c\) has the same sign as \(m\). If no such value exists, a ValueError is raised.

@@ -5137,7 +5137,7 @@

References

numbers

-class sympy.core.numbers.Number(*obj)[source]
+class sympy.core.numbers.Number(*obj)[source]

Represents atomic numbers in SymPy.

Explanation

Floating point numbers are represented by the Float class. @@ -5160,31 +5160,31 @@

References
-as_coeff_Add(rational=False)[source]
+as_coeff_Add(rational=False)[source]

Efficiently extract the coefficient of a summation.

-as_coeff_Mul(rational=False)[source]
+as_coeff_Mul(rational=False)[source]

Efficiently extract the coefficient of a product.

-cofactors(other)[source]
+cofactors(other)[source]

Compute GCD and cofactors of \(self\) and \(other\).

-gcd(other)[source]
+gcd(other)[source]

Compute GCD of \(self\) and \(other\).

-lcm(other)[source]
+lcm(other)[source]

Compute LCM of \(self\) and \(other\).

@@ -5192,7 +5192,7 @@

References
-class sympy.core.numbers.Float(num, dps=None, precision=None)[source]
+class sympy.core.numbers.Float(num, dps=None, precision=None)[source]

Represent a floating-point number of arbitrary precision.

Examples

>>> from sympy import Float
@@ -5356,7 +5356,7 @@ 

References
-class sympy.core.numbers.Rational(p, q=None, gcd=None)[source]
+class sympy.core.numbers.Rational(p, q=None, gcd=None)[source]

Represents rational numbers (p/q) of any size.

Examples

>>> from sympy import Rational, nsimplify, S, pi
@@ -5446,13 +5446,13 @@ 

References
-as_coeff_Add(rational=False)[source]
+as_coeff_Add(rational=False)[source]

Efficiently extract the coefficient of a summation.

-as_coeff_Mul(rational=False)[source]
+as_coeff_Mul(rational=False)[source]

Efficiently extract the coefficient of a product.

@@ -5465,7 +5465,7 @@

Referencesclear=True,

-)[source] +)[source]

Return the tuple (R, self/R) where R is the positive Rational extracted from self.

Examples

@@ -5490,7 +5490,7 @@

Referencesvisual=False,

-)[source] +)[source]

A wrapper to factorint which return factors of self that are smaller than limit (or cheap to compute). Special methods of factoring are disabled by default so that only trial division is used.

@@ -5504,7 +5504,7 @@

Referencesmax_denominator=1000000,

-)[source] +)[source]

Closest Rational to self with denominator at most max_denominator.

Examples

>>> from sympy import Rational
@@ -5520,7 +5520,7 @@ 

References
-class sympy.core.numbers.Integer(i)[source]
+class sympy.core.numbers.Integer(i)[source]

Represents integer numbers of any size.

Examples

>>> from sympy import Integer
@@ -5557,7 +5557,7 @@ 

References**args,

-)[source] +)[source]

Class for representing algebraic numbers in SymPy.

Symbolically, an instance of this class represents an element \(\alpha \in \mathbb{Q}(\theta) \hookrightarrow \mathbb{C}\). That is, the @@ -5582,7 +5582,7 @@

References**args,

-)[source] +)[source]

Construct a new algebraic number \(\alpha\) belonging to a number field \(k = \mathbb{Q}(\theta)\).

There are four instance attributes to be determined:

@@ -5759,25 +5759,25 @@

References
-as_expr(x=None)[source]
+as_expr(x=None)[source]

Create a Basic expression from self.

-as_poly(x=None)[source]
+as_poly(x=None)[source]

Create a Poly instance from self.

-coeffs()[source]
+coeffs()[source]

Returns all SymPy coefficients of an algebraic number.

-field_element(coeffs)[source]
+field_element(coeffs)[source]

Form another element of the same number field.

Parameters:
@@ -5828,7 +5828,7 @@

References
-minpoly_of_element()[source]
+minpoly_of_element()[source]

Compute the minimal polynomial for this algebraic number.

Explanation

Recall that we represent an element \(\alpha \in \mathbb{Q}(\theta)\). @@ -5839,13 +5839,13 @@

References
-native_coeffs()[source]
+native_coeffs()[source]

Returns all native coefficients of an algebraic number.

-primitive_element()[source]
+primitive_element()[source]

Get the primitive element \(\theta\) for the number field \(\mathbb{Q}(\theta)\) to which this algebraic number \(\alpha\) belongs.

@@ -5857,7 +5857,7 @@

References
-to_algebraic_integer()[source]
+to_algebraic_integer()[source]

Convert self to an algebraic integer.

@@ -5869,7 +5869,7 @@

Referencesradicals=True,

-)[source] +)[source]

Convert self to an AlgebraicNumber instance that is equal to its own primitive element.

@@ -5934,7 +5934,7 @@

Referencesminpoly=None,

-)[source] +)[source]

Convert to an Expr that is not an AlgebraicNumber, specifically, either a ComplexRootOf, or, optionally and where possible, an @@ -5960,10 +5960,10 @@

References
-class sympy.core.numbers.NumberSymbol[source]
+class sympy.core.numbers.NumberSymbol[source]
-approximation(number_cls)[source]
+approximation(number_cls)[source]

Return an interval with number_cls endpoints that contains the value of NumberSymbol. If not implemented, then return None.

@@ -5973,13 +5973,13 @@

References
-sympy.core.numbers.RealNumber[source]
+sympy.core.numbers.RealNumber[source]

alias of Float

-sympy.core.numbers.seterr(divide=False)[source]
+sympy.core.numbers.seterr(divide=False)[source]

Should SymPy raise an exception on 0/0 or return a nan?

divide == True …. raise an exception divide == False … return nan

@@ -5987,7 +5987,7 @@

References
-class sympy.core.numbers.Zero[source]
+class sympy.core.numbers.Zero[source]

The number zero.

Zero is a singleton, and can be accessed by S.Zero

Examples

@@ -6009,7 +6009,7 @@

References
-class sympy.core.numbers.One[source]
+class sympy.core.numbers.One[source]

The number one.

One is a singleton, and can be accessed by S.One.

Examples

@@ -6029,7 +6029,7 @@

References
-class sympy.core.numbers.NegativeOne[source]
+class sympy.core.numbers.NegativeOne[source]

The number negative one.

NegativeOne is a singleton, and can be accessed by S.NegativeOne.

Examples

@@ -6053,7 +6053,7 @@

References
-class sympy.core.numbers.Half[source]
+class sympy.core.numbers.Half[source]

The rational number 1/2.

Half is a singleton, and can be accessed by S.Half.

Examples

@@ -6073,7 +6073,7 @@

References
-class sympy.core.numbers.NaN[source]
+class sympy.core.numbers.NaN[source]

Not a Number.

Explanation

This serves as a place holder for numeric values that are indeterminate. @@ -6116,7 +6116,7 @@

References
-class sympy.core.numbers.Infinity[source]
+class sympy.core.numbers.Infinity[source]

Positive infinite quantity.

Explanation

In real analysis the symbol \(\infty\) denotes an unbounded @@ -6154,7 +6154,7 @@

References
-class sympy.core.numbers.NegativeInfinity[source]
+class sympy.core.numbers.NegativeInfinity[source]

Negative infinite quantity.

NegativeInfinity is a singleton, and can be accessed by S.NegativeInfinity.

@@ -6166,7 +6166,7 @@

References
-class sympy.core.numbers.ComplexInfinity[source]
+class sympy.core.numbers.ComplexInfinity[source]

Complex infinity.

Explanation

In complex analysis the symbol \(\tilde\infty\), called “complex @@ -6194,7 +6194,7 @@

References
-class sympy.core.numbers.Exp1[source]
+class sympy.core.numbers.Exp1[source]

The \(e\) constant.

Explanation

The transcendental number \(e = 2.718281828\ldots\) is the base of the @@ -6221,7 +6221,7 @@

References
-class sympy.core.numbers.ImaginaryUnit[source]
+class sympy.core.numbers.ImaginaryUnit[source]

The imaginary unit, \(i = \sqrt{-1}\).

I is a singleton, and can be accessed by S.I, or can be imported as I.

@@ -6246,7 +6246,7 @@

References
-class sympy.core.numbers.Pi[source]
+class sympy.core.numbers.Pi[source]

The \(\pi\) constant.

Explanation

The transcendental number \(\pi = 3.141592654\ldots\) represents the ratio @@ -6281,7 +6281,7 @@

References
-class sympy.core.numbers.EulerGamma[source]
+class sympy.core.numbers.EulerGamma[source]

The Euler-Mascheroni constant.

Explanation

\(\gamma = 0.5772157\ldots\) (also called Euler’s constant) is a mathematical @@ -6314,7 +6314,7 @@

References
-class sympy.core.numbers.Catalan[source]
+class sympy.core.numbers.Catalan[source]

Catalan’s constant.

Explanation

\(G = 0.91596559\ldots\) is given by the infinite series

@@ -6343,7 +6343,7 @@

References
-class sympy.core.numbers.GoldenRatio[source]
+class sympy.core.numbers.GoldenRatio[source]

The golden ratio, \(\phi\).

Explanation

\(\phi = \frac{1 + \sqrt{5}}{2}\) is an algebraic number. Two quantities @@ -6371,7 +6371,7 @@

References
-class sympy.core.numbers.TribonacciConstant[source]
+class sympy.core.numbers.TribonacciConstant[source]

The tribonacci constant.

Explanation

The tribonacci numbers are like the Fibonacci numbers, but instead @@ -6406,7 +6406,7 @@

References
-sympy.core.numbers.mod_inverse(a, m)[source]
+sympy.core.numbers.mod_inverse(a, m)[source]

Return the number \(c\) such that, \(a \times c = 1 \pmod{m}\) where \(c\) has the same sign as \(m\). If no such value exists, a ValueError is raised.

@@ -6452,7 +6452,7 @@

References
-sympy.core.numbers.equal_valued(x, y)[source]
+sympy.core.numbers.equal_valued(x, y)[source]

Compare expressions treating plain floats as rationals.

Examples

>>> from sympy import S, symbols, Rational, Float
@@ -6509,7 +6509,7 @@ 

References

power

-class sympy.core.power.Pow(b, e, evaluate=None)[source]
+class sympy.core.power.Pow(b, e, evaluate=None)[source]

Defines the expression x**y as “x raised to a power y”

Deprecated since version 1.7: Using arguments that aren’t subclasses of Expr in core @@ -6647,7 +6647,7 @@

References
-as_base_exp()[source]
+as_base_exp()[source]

Return base and exp of self.

Explanation

If base a Rational less than 1, then return 1/Rational, -exp. @@ -6675,7 +6675,7 @@

Referencesclear=True,

-)[source] +)[source]

Return the tuple (R, self/R) where R is the positive Rational extracted from self.

Examples

@@ -6726,7 +6726,7 @@

References

mul

-class sympy.core.mul.Mul(*args, evaluate=None, _sympify=True)[source]
+class sympy.core.mul.Mul(*args, evaluate=None, _sympify=True)[source]

Expression representing multiplication operation for algebraic field.

Deprecated since version 1.7: Using arguments that aren’t subclasses of Expr in core @@ -6798,7 +6798,7 @@

References
-as_coeff_Mul(rational=False)[source]
+as_coeff_Mul(rational=False)[source]

Efficiently extract the coefficient of a product.

@@ -6811,7 +6811,7 @@

Referencesclear=True,

-)[source] +)[source]

Return the tuple (R, self/R) where R is the positive Rational extracted from self.

Examples

@@ -6825,7 +6825,7 @@

References
-as_ordered_factors(order=None)[source]
+as_ordered_factors(order=None)[source]

Transform an expression into an ordered list of factors.

Examples

>>> from sympy import sin, cos
@@ -6840,7 +6840,7 @@ 

References
-as_two_terms()[source]
+as_two_terms()[source]

Return head and tail of self.

This is the most efficient way to get the head and tail of an expression.

@@ -6862,7 +6862,7 @@

References
-classmethod flatten(seq)[source]
+classmethod flatten(seq)[source]

Return commutative, noncommutative and order arguments by combining related terms.

Notes

@@ -6945,7 +6945,7 @@

References
-sympy.core.mul.prod(a, start=1)[source]
+sympy.core.mul.prod(a, start=1)[source]
Return product of elements of a. Start with int 1 so if only

ints are included then an int result is returned.

@@ -6974,7 +6974,7 @@

References

add

-class sympy.core.add.Add(*args, evaluate=None, _sympify=True)[source]
+class sympy.core.add.Add(*args, evaluate=None, _sympify=True)[source]

Expression representing addition operation for algebraic group.

Deprecated since version 1.7: Using arguments that aren’t subclasses of Expr in core @@ -7060,13 +7060,13 @@

References
-as_coeff_Add(rational=False, deps=None)[source]
+as_coeff_Add(rational=False, deps=None)[source]

Efficiently extract the coefficient of a summation.

-as_coeff_add(*deps)[source]
+as_coeff_add(*deps)[source]

Returns a tuple (coeff, args) where self is treated as an Add and coeff is the Number term and args is a tuple of all other terms.

Examples

@@ -7088,7 +7088,7 @@

Referencesclear=True,

-)[source] +)[source]

Return the tuple (R, self/R) where R is the positive Rational extracted from self. If radical is True (default is False) then common radicals will be removed and included as a factor of the @@ -7109,7 +7109,7 @@

References
-as_numer_denom()[source]
+as_numer_denom()[source]

Decomposes an expression to its numerator part and its denominator part.

Examples

@@ -7128,7 +7128,7 @@

References
-as_real_imag(deep=True, **hints)[source]
+as_real_imag(deep=True, **hints)[source]

Return a tuple representing a complex number.

Examples

>>> from sympy import I
@@ -7144,7 +7144,7 @@ 

References
-as_two_terms()[source]
+as_two_terms()[source]

Return head and tail of self.

This is the most efficient way to get the head and tail of an expression.

@@ -7165,7 +7165,7 @@

References
-extract_leading_order(symbols, point=None)[source]
+extract_leading_order(symbols, point=None)[source]

Returns the leading term and its order.

Examples

>>> from sympy.abc import x
@@ -7181,7 +7181,7 @@ 

References
-classmethod flatten(seq)[source]
+classmethod flatten(seq)[source]

Takes the sequence “seq” of nested Adds and returns a flatten list.

Returns: (commutative_part, noncommutative_part, order_symbols)

Applies associativity, all terms are commutable with respect to @@ -7195,7 +7195,7 @@

References
-primitive()[source]
+primitive()[source]

Return (R, self/R) where R` is the Rational GCD of self`.

R is collected only from the leading coefficient of each term.

Examples

@@ -7235,7 +7235,7 @@

References

mod

-class sympy.core.mod.Mod(p, q)[source]
+class sympy.core.mod.Mod(p, q)[source]

Represents a modulo operation on symbolic expressions.

Parameters:
@@ -7279,7 +7279,7 @@

References

relational

-class sympy.core.relational.Relational(lhs, rhs, rop=None, **assumptions)[source]
+class sympy.core.relational.Relational(lhs, rhs, rop=None, **assumptions)[source]

Base class for all relation types.

Parameters:
@@ -7407,7 +7407,7 @@

References
-equals(other, failing_expression=False)[source]
+equals(other, failing_expression=False)[source]

Return True if the sides of the relationship are mathematically identical and the type of relationship is the same. If failing_expression is True, return the expression whose truth value @@ -7520,49 +7520,49 @@

References
-sympy.core.relational.Rel[source]
+sympy.core.relational.Rel[source]

alias of Relational

-sympy.core.relational.Eq[source]
+sympy.core.relational.Eq[source]

alias of Equality

-sympy.core.relational.Ne[source]
+sympy.core.relational.Ne[source]

alias of Unequality

-sympy.core.relational.Lt[source]
+sympy.core.relational.Lt[source]

alias of StrictLessThan

-sympy.core.relational.Le[source]
+sympy.core.relational.Le[source]

alias of LessThan

-sympy.core.relational.Gt[source]
+sympy.core.relational.Gt[source]

alias of StrictGreaterThan

-sympy.core.relational.Ge[source]
+sympy.core.relational.Ge[source]

alias of GreaterThan

-class sympy.core.relational.Equality(lhs, rhs, **options)[source]
+class sympy.core.relational.Equality(lhs, rhs, **options)[source]

An equal relation between two objects.

Explanation

Represents that two objects are equal. If they can be easily shown @@ -7621,7 +7621,7 @@

References
-as_poly(*gens, **kwargs)[source]
+as_poly(*gens, **kwargs)[source]

Returns lhs-rhs as a Poly

Examples

>>> from sympy import Eq
@@ -7634,7 +7634,7 @@ 

References
-integrate(*args, **kwargs)[source]
+integrate(*args, **kwargs)[source]

See the integrate function in sympy.integrals

@@ -7642,7 +7642,7 @@

References
-class sympy.core.relational.GreaterThan(lhs, rhs, **options)[source]
+class sympy.core.relational.GreaterThan(lhs, rhs, **options)[source]

Class representations of inequalities.

Explanation

The *Than classes represent inequal relationships, where the left-hand @@ -7896,7 +7896,7 @@

References
-class sympy.core.relational.LessThan(lhs, rhs, **options)[source]
+class sympy.core.relational.LessThan(lhs, rhs, **options)[source]

Class representations of inequalities.

Explanation

The *Than classes represent inequal relationships, where the left-hand @@ -8150,7 +8150,7 @@

References
-class sympy.core.relational.Unequality(lhs, rhs, **options)[source]
+class sympy.core.relational.Unequality(lhs, rhs, **options)[source]

An unequal relation between two objects.

Explanation

Represents that two objects are not equal. If they can be shown to be @@ -8178,7 +8178,7 @@

References
-class sympy.core.relational.StrictGreaterThan(lhs, rhs, **options)[source]
+class sympy.core.relational.StrictGreaterThan(lhs, rhs, **options)[source]

Class representations of inequalities.

Explanation

The *Than classes represent inequal relationships, where the left-hand @@ -8432,7 +8432,7 @@

References
-class sympy.core.relational.StrictLessThan(lhs, rhs, **options)[source]
+class sympy.core.relational.StrictLessThan(lhs, rhs, **options)[source]

Class representations of inequalities.

Explanation

The *Than classes represent inequal relationships, where the left-hand @@ -8689,7 +8689,7 @@

References

multidimensional

-class sympy.core.multidimensional.vectorize(*mdargs)[source]
+class sympy.core.multidimensional.vectorize(*mdargs)[source]

Generalizes a function taking scalars to accept multidimensional arguments.

Examples

>>> from sympy import vectorize, diff, sin, symbols, Function
@@ -8722,7 +8722,7 @@ 

References

function

-class sympy.core.function.Lambda(signature, expr)[source]
+class sympy.core.function.Lambda(signature, expr)[source]

Lambda(x, expr) represents a lambda function similar to Python’s ‘lambda x: expr’. A function of several variables is written as Lambda((x, y, …), expr).

@@ -8789,7 +8789,7 @@

References
-class sympy.core.function.WildFunction(*args)[source]
+class sympy.core.function.WildFunction(*args)[source]

A WildFunction function matches any function (with its arguments).

Examples

>>> from sympy import WildFunction, Function, cos
@@ -8836,7 +8836,7 @@ 

References
-class sympy.core.function.Derivative(expr, *variables, **kwargs)[source]
+class sympy.core.function.Derivative(expr, *variables, **kwargs)[source]

Carries out differentiation of the given expression with respect to symbols.

Examples

>>> from sympy import Derivative, Function, symbols, Subs
@@ -9040,7 +9040,7 @@ 

References
-classmethod _sort_variable_count(vc)[source]
+classmethod _sort_variable_count(vc)[source]

Sort (variable, count) pairs into canonical order while retaining order of variables that do not commute during differentiation:

@@ -9099,7 +9099,7 @@

Referenceswrt=None,

-)[source] +)[source]

Expresses a Derivative instance as a finite difference.

Parameters:
@@ -9185,7 +9185,7 @@

References
-doit_numerically(z0)[source]
+doit_numerically(z0)[source]

Evaluate the derivative at z numerically.

When we can represent derivatives at a point, this should be folded into the normal evalf. For now, we need a special method.

@@ -9195,7 +9195,7 @@

References
-sympy.core.function.diff(f, *symbols, **kwargs)[source]
+sympy.core.function.diff(f, *symbols, **kwargs)[source]

Differentiate f with respect to symbols.

Explanation

This is just a wrapper to unify .diff() and the Derivative class; its @@ -9261,7 +9261,7 @@

References
-class sympy.core.function.FunctionClass(*args, **kwargs)[source]
+class sympy.core.function.FunctionClass(*args, **kwargs)[source]

Base class for function classes. FunctionClass is a subclass of type.

Use Function(‘<function name>’ [ , signature ]) to create undefined function classes.

@@ -9304,7 +9304,7 @@

References
-class sympy.core.function.Function(*args)[source]
+class sympy.core.function.Function(*args)[source]

Base class for applied mathematical functions.

It also serves as a constructor for undefined function classes.

See the Writing Custom Functions guide for details on how to subclass @@ -9352,13 +9352,13 @@

References
-fdiff(argindex=1)[source]
+fdiff(argindex=1)[source]

Returns the first derivative of the function.

-classmethod is_singular(a)[source]
+classmethod is_singular(a)[source]

Tests whether the argument is an essential singularity or a branch point, or the functions is non-holomorphic.

@@ -9395,7 +9395,7 @@

References
-class sympy.core.function.Subs(expr, variables, point, **assumptions)[source]
+class sympy.core.function.Subs(expr, variables, point, **assumptions)[source]

Represents unevaluated substitutions of an expression.

Subs(expr, x, x0) represents the expression resulting from substituting x with x0 in expr.

@@ -9517,7 +9517,7 @@

References**hints,

-)[source] +)[source]

Expand an expression using methods given as hints.

Explanation

Hints evaluated unless explicitly set to False are: basic, log, @@ -9800,12 +9800,12 @@

References
-class sympy.core.function.PoleError[source]
+class sympy.core.function.PoleError[source]

-sympy.core.function.count_ops(expr, visual=False)[source]
+sympy.core.function.count_ops(expr, visual=False)[source]

Return a representation (integer or expression) of the operations in expr.

Parameters:
@@ -9880,7 +9880,7 @@

References
-sympy.core.function.expand_mul(expr, deep=True)[source]
+sympy.core.function.expand_mul(expr, deep=True)[source]

Wrapper around expand that only uses the mul hint. See the expand docstring for more information.

Examples

@@ -9903,7 +9903,7 @@

Referencesfactor=False,

-)[source] +)[source]

Wrapper around expand that only uses the log hint. See the expand docstring for more information.

Examples

@@ -9917,7 +9917,7 @@

References
-sympy.core.function.expand_func(expr, deep=True)[source]
+sympy.core.function.expand_func(expr, deep=True)[source]

Wrapper around expand that only uses the func hint. See the expand docstring for more information.

Examples

@@ -9931,7 +9931,7 @@

References
-sympy.core.function.expand_trig(expr, deep=True)[source]
+sympy.core.function.expand_trig(expr, deep=True)[source]

Wrapper around expand that only uses the trig hint. See the expand docstring for more information.

Examples

@@ -9945,7 +9945,7 @@

References
-sympy.core.function.expand_complex(expr, deep=True)[source]
+sympy.core.function.expand_complex(expr, deep=True)[source]

Wrapper around expand that only uses the complex hint. See the expand docstring for more information.

Examples

@@ -9965,7 +9965,7 @@

References
-sympy.core.function.expand_multinomial(expr, deep=True)[source]
+sympy.core.function.expand_multinomial(expr, deep=True)[source]

Wrapper around expand that only uses the multinomial hint. See the expand docstring for more information.

Examples

@@ -9979,7 +9979,7 @@

References
-sympy.core.function.expand_power_exp(expr, deep=True)[source]
+sympy.core.function.expand_power_exp(expr, deep=True)[source]

Wrapper around expand that only uses the power_exp hint.

See the expand docstring for more information.

Examples

@@ -10002,7 +10002,7 @@

References
-sympy.core.function.expand_power_base(expr, deep=True, force=False)[source]
+sympy.core.function.expand_power_base(expr, deep=True, force=False)[source]

Wrapper around expand that only uses the power_base hint.

A wrapper to expand(power_base=True) which separates a power with a base that is a Mul into a product of powers, without performing any other @@ -10087,7 +10087,7 @@

References
-sympy.core.function.nfloat(expr, n=15, exponent=False, dkeys=False)[source]
+sympy.core.function.nfloat(expr, n=15, exponent=False, dkeys=False)[source]

Make all Rationals in expr Floats except those in exponents (unless the exponents flag is set to True) and those in undefined functions. When processing dictionaries, do not modify the keys @@ -10113,7 +10113,7 @@

References

evalf

-class sympy.core.evalf.EvalfMixin[source]
+class sympy.core.evalf.EvalfMixin[source]

Mixin class adding evalf capability.

@@ -10129,7 +10129,7 @@

Referencesverbose=False,

-)[source] +)[source]

Evaluate the given formula to an accuracy of n digits.

Parameters:
@@ -10212,7 +10212,7 @@

Referencesverbose=False,

-)[source] +)[source]

Evaluate the given formula to an accuracy of n digits.

Parameters:
@@ -10285,12 +10285,12 @@

References
-class sympy.core.evalf.PrecisionExhausted[source]
+class sympy.core.evalf.PrecisionExhausted[source]

-sympy.core.evalf.N(x, n=15, **options)[source]
+sympy.core.evalf.N(x, n=15, **options)[source]

Calls x.evalf(n, **options).

Explanations

Both .n() and N() are equivalent to .evalf(); use the one that you like better. @@ -10311,7 +10311,7 @@

References

containers

-class sympy.core.containers.Tuple(*args, **kwargs)[source]
+class sympy.core.containers.Tuple(*args, **kwargs)[source]

Wrapper around the builtin tuple object.

Parameters:
@@ -10338,7 +10338,7 @@

References
-index(value, start=None, stop=None)[source]
+index(value, start=None, stop=None)[source]

Searches and returns the first index of the value.

@@ -10366,7 +10366,7 @@

References
-tuple_count(value) int[source]
+tuple_count(value) int[source]

Return number of occurrences of value.

@@ -10374,7 +10374,7 @@

References
-class sympy.core.containers.TupleKind(*args)[source]
+class sympy.core.containers.TupleKind(*args)[source]

TupleKind is a subclass of Kind, which is used to define Kind of Tuple.

Parameters of TupleKind will be kinds of all the arguments in Tuples, for example

@@ -10403,7 +10403,7 @@

References
-class sympy.core.containers.Dict(*args)[source]
+class sympy.core.containers.Dict(*args)[source]

Wrapper around the builtin dict object.

Explanation

The Dict is a subclass of Basic, so that it works well in the @@ -10436,25 +10436,25 @@

References
-get(key, default=None)[source]
+get(key, default=None)[source]

Returns the value for key if the key is in the dictionary.

-items()[source]
+items()[source]

Returns a set-like object providing a view on dict’s items.

-keys()[source]
+keys()[source]

Returns the list of the dict’s keys.

-values()[source]
+values()[source]

Returns the list of the dict’s values.

@@ -10474,7 +10474,7 @@

Referencesfraction=True,

-)[source] +)[source]

Compute the GCD of terms and put them together.

Parameters:
@@ -10551,7 +10551,7 @@

Referencessign=True,

-)[source] +)[source]

Remove common factors from terms in all arguments without changing the underlying structure of the expr. No expansion or simplification (and no processing of non-commutatives) is performed.

@@ -10620,7 +10620,7 @@

References

kind

-class sympy.core.kind.Kind(*args)[source]
+class sympy.core.kind.Kind(*args)[source]

Base class for kinds.

Kind of the object represents the mathematical classification that the entity falls into. It is expected that functions and classes @@ -10664,7 +10664,7 @@

References

-sympy.core.sorting.default_sort_key(item, order=None)[source]
+sympy.core.sorting.default_sort_key(item, order=None)[source]

Return a key that can be used for sorting.

The key has the structure:

(class_key, (len(args), args), exponent.sort_key(), coefficient)

@@ -10770,7 +10770,7 @@

Sorting
-sympy.core.sorting.ordered(seq, keys=None, default=True, warn=False)[source]
+sympy.core.sorting.ordered(seq, keys=None, default=True, warn=False)[source]

Return an iterator of the seq where keys are used to break ties in a conservative fashion: if, after applying a key, there are no ties then no other keys will be computed.

@@ -10881,7 +10881,7 @@

Examplestolerance=None,

-)[source] +)[source]

Return a random complex number.

To reduce chance of hitting branch cuts or anything, we guarantee b <= Im z <= d, a <= Re z <= c

@@ -10904,7 +10904,7 @@

Examplesd=1,

-)[source] +)[source]

Test numerically that f and g agree when evaluated in the argument z.

If z is None, all symbols will be tested. This routine does not test whether there are Floats present with precision higher than 15 digits @@ -10934,7 +10934,7 @@

Examplesd=1,

-)[source] +)[source]

Test numerically that the symbolically computed derivative of f with respect to z is correct.

This routine does not test whether there are Floats present with @@ -10952,7 +10952,7 @@

Examples
-sympy.core.random._randrange(seed=None)[source]
+sympy.core.random._randrange(seed=None)[source]

Return a randrange generator.

seed can be

    @@ -10978,7 +10978,7 @@

    Examples
    -sympy.core.random._randint(seed=None)[source]
    +sympy.core.random._randint(seed=None)[source]

    Return a randint generator.

    seed can be

      @@ -11007,7 +11007,7 @@

      Examples

      Traversal

      -sympy.core.traversal.bottom_up(rv, F, atoms=False, nonbasic=False)[source]
      +sympy.core.traversal.bottom_up(rv, F, atoms=False, nonbasic=False)[source]

      Apply F to all expressions in an expression tree from the bottom up. If atoms is True, apply F even if there are no args; if nonbasic is True, try to apply F to non-Basic objects.

      @@ -11015,7 +11015,7 @@

      Examples
      -sympy.core.traversal.postorder_traversal(node, keys=None)[source]
      +sympy.core.traversal.postorder_traversal(node, keys=None)[source]

      Do a postorder traversal of a tree.

      This generator recursively yields nodes that it has visited in a postorder fashion. That is, it descends through the tree depth-first to yield all of @@ -11060,7 +11060,7 @@

      Examples
      -sympy.core.traversal.preorder_traversal(node, keys=None)[source]
      +sympy.core.traversal.preorder_traversal(node, keys=None)[source]

      Do a pre-order traversal of a tree.

      This iterator recursively yields nodes that it has visited in a pre-order fashion. That is, it yields the current node then descends through the @@ -11108,7 +11108,7 @@

      Examples
      -sympy.core.traversal.use(expr, func, level=0, args=(), kwargs={})[source]
      +sympy.core.traversal.use(expr, func, level=0, args=(), kwargs={})[source]

      Use func to transform expr at the given level.

      Examples

      >>> from sympy import use, expand
      @@ -11128,7 +11128,7 @@ 

      Examples
      -sympy.core.traversal.walk(e, *target)[source]
      +sympy.core.traversal.walk(e, *target)[source]

      Iterate through the args that are the given types (target) and return a list of the args that were traversed; arguments that are not of the specified types are not traversed.

      diff --git a/dev/modules/crypto.html b/dev/modules/crypto.html index ba875406b4c..11ae01b17ba 100644 --- a/dev/modules/crypto.html +++ b/dev/modules/crypto.html @@ -838,7 +838,7 @@

      Cryptography
      -sympy.crypto.crypto.AZ(s=None)[source]
      +sympy.crypto.crypto.AZ(s=None)[source]

      Return the letters of s in uppercase. In case more than one string is passed, each of them will be processed and a list of upper case strings will be returned.

      @@ -858,7 +858,7 @@

      Cryptography
      -sympy.crypto.crypto.padded_key(key, symbols)[source]
      +sympy.crypto.crypto.padded_key(key, symbols)[source]

      Return a string of the distinct characters of symbols with those of key appearing first. A ValueError is raised if a) there are duplicate characters in symbols or @@ -877,7 +877,7 @@

      Cryptography
      -sympy.crypto.crypto.check_and_join(phrase, symbols=None, filter=None)[source]
      +sympy.crypto.crypto.check_and_join(phrase, symbols=None, filter=None)[source]

      Joins characters of phrase and if symbols is given, raises an error if any character in phrase is not in symbols.

      @@ -911,7 +911,7 @@

      Cryptography
      -sympy.crypto.crypto.cycle_list(k, n)[source]
      +sympy.crypto.crypto.cycle_list(k, n)[source]

      Returns the elements of the list range(n) shifted to the left by k (so the list starts with k (mod n)).

      Examples

      @@ -924,7 +924,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_shift(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.encipher_shift(msg, key, symbols=None)[source]

      Performs shift cipher encryption on plaintext msg, and returns the ciphertext.

      @@ -1003,7 +1003,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_shift(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.decipher_shift(msg, key, symbols=None)[source]

      Return the text by shifting the characters of msg to the left by the amount given by key.

      Examples

      @@ -1027,7 +1027,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_rot13(msg, symbols=None)[source]
      +sympy.crypto.crypto.encipher_rot13(msg, symbols=None)[source]

      Performs the ROT13 encryption on a given plaintext msg.

      Explanation

      ROT13 is a substitution cipher which substitutes each letter @@ -1050,7 +1050,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_rot13(msg, symbols=None)[source]
      +sympy.crypto.crypto.decipher_rot13(msg, symbols=None)[source]

      Performs the ROT13 decryption on a given plaintext msg.

      Explanation

      decipher_rot13 is equivalent to encipher_rot13 as both @@ -1084,7 +1084,7 @@

      Cryptography_inverse=False,

      -)[source] +)[source]

      Performs the affine cipher encryption on plaintext msg, and returns the ciphertext.

      @@ -1154,7 +1154,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_affine(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.decipher_affine(msg, key, symbols=None)[source]

      Return the deciphered text that was made from the mapping, \(x \rightarrow ax+b\) (mod \(N\)), where N is the number of characters in the alphabet. Deciphering is done by @@ -1178,7 +1178,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_atbash(msg, symbols=None)[source]
      +sympy.crypto.crypto.encipher_atbash(msg, symbols=None)[source]

      Enciphers a given msg into its Atbash ciphertext and returns it.

      Explanation

      Atbash is a substitution cipher originally used to encrypt the Hebrew @@ -1194,7 +1194,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_atbash(msg, symbols=None)[source]
      +sympy.crypto.crypto.decipher_atbash(msg, symbols=None)[source]

      Deciphers a given msg using Atbash cipher and returns it.

      Explanation

      decipher_atbash is functionally equivalent to encipher_atbash. @@ -1228,7 +1228,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_substitution(msg, old, new=None)[source]
      +sympy.crypto.crypto.encipher_substitution(msg, old, new=None)[source]

      Returns the ciphertext obtained by replacing each character that appears in old with the corresponding character in new. If old is a mapping, then new is ignored and the replacements @@ -1283,7 +1283,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_vigenere(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.encipher_vigenere(msg, key, symbols=None)[source]

      Performs the Vigenere cipher encryption on plaintext msg, and returns the ciphertext.

      Examples

      @@ -1440,7 +1440,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_vigenere(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.decipher_vigenere(msg, key, symbols=None)[source]

      Decode using the Vigenere cipher.

      Examples

      >>> from sympy.crypto.crypto import decipher_vigenere
      @@ -1454,7 +1454,7 @@ 

      Cryptography
      -sympy.crypto.crypto.encipher_hill(msg, key, symbols=None, pad='Q')[source]
      +sympy.crypto.crypto.encipher_hill(msg, key, symbols=None, pad='Q')[source]

      Return the Hill cipher encryption of msg.

      Parameters:
      @@ -1539,7 +1539,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_hill(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.decipher_hill(msg, key, symbols=None)[source]

      Deciphering is the same as enciphering but using the inverse of the key matrix.

      Examples

      @@ -1590,7 +1590,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_bifid(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.encipher_bifid(msg, key, symbols=None)[source]

      Performs the Bifid cipher encryption on plaintext msg, and returns the ciphertext.

      This is the version of the Bifid cipher that uses an \(n \times n\) @@ -1635,7 +1635,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_bifid(msg, key, symbols=None)[source]
      +sympy.crypto.crypto.decipher_bifid(msg, key, symbols=None)[source]

      Performs the Bifid cipher decryption on ciphertext msg, and returns the plaintext.

      This is the version of the Bifid cipher that uses the \(n \times n\) @@ -1714,7 +1714,7 @@

      Cryptography
      -sympy.crypto.crypto.bifid5_square(key=None)[source]
      +sympy.crypto.crypto.bifid5_square(key=None)[source]

      5x5 Polybius square.

      Produce the Polybius square for the \(5 \times 5\) Bifid cipher.

      Examples

      @@ -1732,7 +1732,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_bifid5(msg, key)[source]
      +sympy.crypto.crypto.encipher_bifid5(msg, key)[source]

      Performs the Bifid cipher encryption on plaintext msg, and returns the ciphertext.

      @@ -1835,7 +1835,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_bifid5(msg, key)[source]
      +sympy.crypto.crypto.decipher_bifid5(msg, key)[source]

      Return the Bifid cipher decryption of msg.

      Parameters:
      @@ -1877,7 +1877,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_bifid6(msg, key)[source]
      +sympy.crypto.crypto.encipher_bifid6(msg, key)[source]

      Performs the Bifid cipher encryption on plaintext msg, and returns the ciphertext.

      This is the version of the Bifid cipher that uses the \(6 \times 6\) @@ -1910,7 +1910,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_bifid6(msg, key)[source]
      +sympy.crypto.crypto.decipher_bifid6(msg, key)[source]

      Performs the Bifid cipher decryption on ciphertext msg, and returns the plaintext.

      This is the version of the Bifid cipher that uses the \(6 \times 6\) @@ -1949,7 +1949,7 @@

      Cryptography
      -sympy.crypto.crypto.bifid6_square(key=None)[source]
      +sympy.crypto.crypto.bifid6_square(key=None)[source]

      6x6 Polybius square.

      Produces the Polybius square for the \(6 \times 6\) Bifid cipher. Assumes alphabet of symbols is “A”, …, “Z”, “0”, …, “9”.

      @@ -1970,7 +1970,7 @@

      Cryptography
      -sympy.crypto.crypto.rsa_public_key(*args, **kwargs)[source]
      +sympy.crypto.crypto.rsa_public_key(*args, **kwargs)[source]

      Return the RSA public key pair, \((n, e)\)

      Parameters:
      @@ -2136,7 +2136,7 @@

      Cryptography
      -sympy.crypto.crypto.rsa_private_key(*args, **kwargs)[source]
      +sympy.crypto.crypto.rsa_private_key(*args, **kwargs)[source]

      Return the RSA private key pair, \((n, d)\)

      Parameters:
      @@ -2262,7 +2262,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_rsa(i, key, factors=None)[source]
      +sympy.crypto.crypto.encipher_rsa(i, key, factors=None)[source]

      Encrypt the plaintext with RSA.

      Parameters:
      @@ -2327,7 +2327,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_rsa(i, key, factors=None)[source]
      +sympy.crypto.crypto.decipher_rsa(i, key, factors=None)[source]

      Decrypt the ciphertext with RSA.

      Parameters:
      @@ -2422,7 +2422,7 @@

      Cryptography
      -sympy.crypto.crypto.kid_rsa_public_key(a, b, A, B)[source]
      +sympy.crypto.crypto.kid_rsa_public_key(a, b, A, B)[source]

      Kid RSA is a version of RSA useful to teach grade school children since it does not involve exponentiation.

      Explanation

      @@ -2450,7 +2450,7 @@

      Cryptography
      -sympy.crypto.crypto.kid_rsa_private_key(a, b, A, B)[source]
      +sympy.crypto.crypto.kid_rsa_private_key(a, b, A, B)[source]

      Compute \(M = a b - 1\), \(e = A M + a\), \(d = B M + b\), \(n = (e d - 1) / M\). The private key is \(d\), which Bob keeps secret.

      @@ -2465,7 +2465,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_kid_rsa(msg, key)[source]
      +sympy.crypto.crypto.encipher_kid_rsa(msg, key)[source]

      Here msg is the plaintext and key is the public key.

      Examples

      >>> from sympy.crypto.crypto import (
      @@ -2481,7 +2481,7 @@ 

      Cryptography
      -sympy.crypto.crypto.decipher_kid_rsa(msg, key)[source]
      +sympy.crypto.crypto.decipher_kid_rsa(msg, key)[source]

      Here msg is the plaintext and key is the private key.

      Examples

      >>> from sympy.crypto.crypto import (
      @@ -2501,7 +2501,7 @@ 

      Cryptography
      -sympy.crypto.crypto.encode_morse(msg, sep='|', mapping=None)[source]
      +sympy.crypto.crypto.encode_morse(msg, sep='|', mapping=None)[source]

      Encodes a plaintext into popular Morse Code with letters separated by sep and words by a double sep.

      Examples

      @@ -2522,7 +2522,7 @@

      Cryptography
      -sympy.crypto.crypto.decode_morse(msg, sep='|', mapping=None)[source]
      +sympy.crypto.crypto.decode_morse(msg, sep='|', mapping=None)[source]

      Decodes a Morse Code with letters separated by sep (default is ‘|’) and words by \(word_sep\) (default is ‘||) into plaintext.

      @@ -2544,7 +2544,7 @@

      Cryptography
      -sympy.crypto.crypto.lfsr_sequence(key, fill, n)[source]
      +sympy.crypto.crypto.lfsr_sequence(key, fill, n)[source]

      This function creates an LFSR sequence.

      Parameters:
      @@ -2633,7 +2633,7 @@

      Cryptography
      -sympy.crypto.crypto.lfsr_autocorrelation(L, P, k)[source]
      +sympy.crypto.crypto.lfsr_autocorrelation(L, P, k)[source]

      This function computes the LFSR autocorrelation function.

      Parameters:
      @@ -2676,7 +2676,7 @@

      Cryptography
      -sympy.crypto.crypto.lfsr_connection_polynomial(s)[source]
      +sympy.crypto.crypto.lfsr_connection_polynomial(s)[source]

      This function computes the LFSR connection polynomial.

      Parameters:
      @@ -2736,7 +2736,7 @@

      Cryptography
      -sympy.crypto.crypto.elgamal_public_key(key)[source]
      +sympy.crypto.crypto.elgamal_public_key(key)[source]

      Return three number tuple as public key.

      Parameters:
      @@ -2763,7 +2763,7 @@

      Cryptography
      -sympy.crypto.crypto.elgamal_private_key(digit=10, seed=None)[source]
      +sympy.crypto.crypto.elgamal_private_key(digit=10, seed=None)[source]

      Return three number tuple as private key.

      Parameters:
      @@ -2805,7 +2805,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_elgamal(i, key, seed=None)[source]
      +sympy.crypto.crypto.encipher_elgamal(i, key, seed=None)[source]

      Encrypt message with public key.

      Parameters:
      @@ -2851,7 +2851,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_elgamal(msg, key)[source]
      +sympy.crypto.crypto.decipher_elgamal(msg, key)[source]

      Decrypt message with private key.

      \(msg = (c_{1}, c_{2})\)

      \(key = (p, r, d)\)

      @@ -2879,7 +2879,7 @@

      Cryptography
      -sympy.crypto.crypto.dh_public_key(key)[source]
      +sympy.crypto.crypto.dh_public_key(key)[source]

      Return three number tuple as public key.

      This is the tuple that Alice sends to Bob.

      @@ -2911,7 +2911,7 @@

      Cryptography
      -sympy.crypto.crypto.dh_private_key(digit=10, seed=None)[source]
      +sympy.crypto.crypto.dh_private_key(digit=10, seed=None)[source]

      Return three integer tuple as private key.

      Parameters:
      @@ -2967,7 +2967,7 @@

      Cryptography
      -sympy.crypto.crypto.dh_shared_key(key, b)[source]
      +sympy.crypto.crypto.dh_shared_key(key, b)[source]

      Return an integer that is the shared key.

      This is what Bob and Alice can both calculate using the public keys they received from each other and their private keys.

      @@ -3004,7 +3004,7 @@

      Cryptography
      -sympy.crypto.crypto.gm_public_key(p, q, a=None, seed=None)[source]
      +sympy.crypto.crypto.gm_public_key(p, q, a=None, seed=None)[source]

      Compute public keys for p and q. Note that in Goldwasser-Micali Encryption, public keys are randomly selected.

      @@ -3028,7 +3028,7 @@

      Cryptography
      -sympy.crypto.crypto.gm_private_key(p, q, a=None)[source]
      +sympy.crypto.crypto.gm_private_key(p, q, a=None)[source]

      Check if p and q can be used as private keys for the Goldwasser-Micali encryption. The method works roughly as follows.

      @@ -3088,7 +3088,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_gm(i, key, seed=None)[source]
      +sympy.crypto.crypto.encipher_gm(i, key, seed=None)[source]

      Encrypt integer ‘i’ using public_key ‘key’ Note that gm uses random encryption.

      @@ -3113,7 +3113,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_gm(message, key)[source]
      +sympy.crypto.crypto.decipher_gm(message, key)[source]

      Decrypt message ‘message’ using public_key ‘key’.

      Parameters:
      @@ -3137,7 +3137,7 @@

      Cryptography
      -sympy.crypto.crypto.encipher_railfence(message, rails)[source]
      +sympy.crypto.crypto.encipher_railfence(message, rails)[source]

      Performs Railfence Encryption on plaintext and returns ciphertext

      Parameters:
      @@ -3166,7 +3166,7 @@

      Cryptography
      -sympy.crypto.crypto.decipher_railfence(ciphertext, rails)[source]
      +sympy.crypto.crypto.decipher_railfence(ciphertext, rails)[source]

      Decrypt the message using the given rails

      Parameters:
      diff --git a/dev/modules/diffgeom.html b/dev/modules/diffgeom.html index d8589452611..4d8fd3e763a 100644 --- a/dev/modules/diffgeom.html +++ b/dev/modules/diffgeom.html @@ -810,7 +810,7 @@

      Introduction

      -class sympy.diffgeom.Manifold(name, dim, **kwargs)[source]
      +class sympy.diffgeom.Manifold(name, dim, **kwargs)[source]

      A mathematical manifold.

      Parameters:
      @@ -849,7 +849,7 @@

      Base Class Reference
      -class sympy.diffgeom.Patch(name, manifold, **kwargs)[source]
      +class sympy.diffgeom.Patch(name, manifold, **kwargs)[source]

      A patch on a manifold.

      Parameters:
      @@ -903,7 +903,7 @@

      Base Class Reference**kwargs,

      -)[source] +)[source]

      A coordinate system defined on the patch.

      Parameters:
      @@ -1012,7 +1012,7 @@

      Base Class Reference
      -base_oneform(coord_index)[source]
      +base_oneform(coord_index)[source]

      Return a basis 1-form field. The basis one-form field for this coordinate system. It is also an operator on vector fields.

      @@ -1020,27 +1020,27 @@

      Base Class Reference
      -base_oneforms()[source]
      +base_oneforms()[source]

      Returns a list of all base oneforms. For more details see the base_oneform method of this class.

      -base_scalar(coord_index)[source]
      +base_scalar(coord_index)[source]

      Return BaseScalarField that takes a point and returns one of the coordinates.

      -base_scalars()[source]
      +base_scalars()[source]

      Returns a list of all coordinate functions. For more details see the base_scalar method of this class.

      -base_vector(coord_index)[source]
      +base_vector(coord_index)[source]

      Return a basis vector field. The basis vector field for this coordinate system. It is also an operator on scalar fields.

      @@ -1048,20 +1048,20 @@

      Base Class Reference
      -base_vectors()[source]
      +base_vectors()[source]

      Returns a list of all base vectors. For more details see the base_vector method of this class.

      -coord_function(coord_index)[source]
      +coord_function(coord_index)[source]

      Return BaseScalarField that takes a point and returns one of the coordinates.

      -coord_functions()[source]
      +coord_functions()[source]

      Returns a list of all coordinate functions. For more details see the base_scalar method of this class.

      @@ -1075,13 +1075,13 @@

      Base Class Referencecoords,

      -)[source] +)[source]

      Transform coords to coord system to_sys.

      -jacobian(sys, coordinates=None)[source]
      +jacobian(sys, coordinates=None)[source]

      Return the jacobian matrix of a transformation on given coordinates. If coordinates are not given, coordinate symbols of self are used.

      @@ -1116,7 +1116,7 @@

      Base Class Referencecoordinates=None,

      -)[source] +)[source]

      Return the jacobian determinant of a transformation on given coordinates. If coordinates are not given, coordinate symbols of self are used.

      @@ -1141,7 +1141,7 @@

      Base Class Reference
      -jacobian_matrix(sys, coordinates=None)[source]
      +jacobian_matrix(sys, coordinates=None)[source]

      Return the jacobian matrix of a transformation on given coordinates. If coordinates are not given, coordinate symbols of self are used.

      @@ -1169,19 +1169,19 @@

      Base Class Reference
      -point(coords)[source]
      +point(coords)[source]

      Create a Point with coordinates given in this coord system.

      -point_to_coords(point)[source]
      +point_to_coords(point)[source]

      Calculate the coordinates of a point in this coord system.

      -transform(sys, coordinates=None)[source]
      +transform(sys, coordinates=None)[source]

      Return the result of coordinate transformation from self to sys. If coordinates are not given, coordinate symbols of self are used.

      @@ -1209,7 +1209,7 @@

      Base Class Reference
      -transformation(sys)[source]
      +transformation(sys)[source]

      Return coordinate transformation function from self to sys.

      Parameters:
      @@ -1233,7 +1233,7 @@

      Base Class Reference
      -class sympy.diffgeom.CoordinateSymbol(coord_sys, index, **assumptions)[source]
      +class sympy.diffgeom.CoordinateSymbol(coord_sys, index, **assumptions)[source]

      A symbol which denotes an abstract value of i-th coordinate of the coordinate system with given context.

      @@ -1286,7 +1286,7 @@

      Base Class Reference
      -class sympy.diffgeom.Point(coord_sys, coords, **kwargs)[source]
      +class sympy.diffgeom.Point(coord_sys, coords, **kwargs)[source]

      Point defined in a coordinate system.

      Parameters:
      @@ -1332,7 +1332,7 @@

      Base Class Reference
      -coords(sys=None)[source]
      +coords(sys=None)[source]

      Coordinates of the point in given coordinate system. If coordinate system is not passed, it returns the coordinates in the coordinate system in which the poin was defined.

      @@ -1342,7 +1342,7 @@

      Base Class Reference
      -class sympy.diffgeom.BaseScalarField(coord_sys, index, **kwargs)[source]
      +class sympy.diffgeom.BaseScalarField(coord_sys, index, **kwargs)[source]

      Base scalar field over a manifold for a given coordinate system.

      Parameters:
      @@ -1392,7 +1392,7 @@

      Base Class Reference
      -class sympy.diffgeom.BaseVectorField(coord_sys, index, **kwargs)[source]
      +class sympy.diffgeom.BaseVectorField(coord_sys, index, **kwargs)[source]

      Base vector field over a manifold for a given coordinate system.

      Parameters:
      @@ -1448,7 +1448,7 @@

      Base Class Reference
      -class sympy.diffgeom.Commutator(v1, v2)[source]
      +class sympy.diffgeom.Commutator(v1, v2)[source]

      Commutator of two vector fields.

      Explanation

      The commutator of two vector fields \(v_1\) and \(v_2\) is defined as the @@ -1482,7 +1482,7 @@

      Base Class Reference
      -class sympy.diffgeom.Differential(form_field)[source]
      +class sympy.diffgeom.Differential(form_field)[source]

      Return the differential (exterior derivative) of a form field.

      Explanation

      The differential of a form (i.e. the exterior derivative) has a complicated @@ -1524,7 +1524,7 @@

      Base Class Reference
      -class sympy.diffgeom.TensorProduct(*args)[source]
      +class sympy.diffgeom.TensorProduct(*args)[source]

      Tensor product of forms.

      Explanation

      The tensor product permits the creation of multilinear functionals (i.e. @@ -1578,7 +1578,7 @@

      Base Class Reference
      -class sympy.diffgeom.WedgeProduct(*args)[source]
      +class sympy.diffgeom.WedgeProduct(*args)[source]

      Wedge product of forms.

      Explanation

      In the context of integration only completely antisymmetric forms make @@ -1613,7 +1613,7 @@

      Base Class Reference
      -class sympy.diffgeom.LieDerivative(v_field, expr)[source]
      +class sympy.diffgeom.LieDerivative(v_field, expr)[source]

      Lie derivative with respect to a vector field.

      Explanation

      The transport operator that defines the Lie derivative is the pushforward of @@ -1665,7 +1665,7 @@

      Base Class Referencechristoffel,

      -)[source] +)[source]

      Covariant derivative operator with respect to a base vector.

      Examples

      >>> from sympy.diffgeom.rn import R2_r
      @@ -1693,7 +1693,7 @@ 

      Base Class Reference
      -class sympy.diffgeom.CovarDerivativeOp(wrt, christoffel)[source]
      +class sympy.diffgeom.CovarDerivativeOp(wrt, christoffel)[source]

      Covariant derivative operator.

      Examples

      >>> from sympy.diffgeom.rn import R2_r
      @@ -1730,7 +1730,7 @@ 

      Base Class Referencecoeffs=False,

      -)[source] +)[source]

      Return the series expansion for an integral curve of the field.

      Parameters:
      @@ -1839,7 +1839,7 @@

      Base Class Referencecoord_sys=None,

      -)[source] +)[source]

      Return the differential equation for an integral curve of the field.

      Parameters:
      @@ -1911,7 +1911,7 @@

      Base Class Reference
      -sympy.diffgeom.vectors_in_basis(expr, to_sys)[source]
      +sympy.diffgeom.vectors_in_basis(expr, to_sys)[source]

      Transform all base vectors in base vectors of a specified coord basis. While the new base vectors are in the new coordinate system basis, any coefficients are kept in the old system.

      @@ -1930,7 +1930,7 @@

      Base Class Reference
      -sympy.diffgeom.twoform_to_matrix(expr)[source]
      +sympy.diffgeom.twoform_to_matrix(expr)[source]

      Return the matrix representing the twoform.

      For the twoform \(w\) return the matrix \(M\) such that \(M[i,j]=w(e_i, e_j)\), where \(e_i\) is the i-th base vector field for the coordinate system in @@ -1959,7 +1959,7 @@

      Base Class Reference
      -sympy.diffgeom.metric_to_Christoffel_1st(expr)[source]
      +sympy.diffgeom.metric_to_Christoffel_1st(expr)[source]

      Return the nested list of Christoffel symbols for the given metric. This returns the Christoffel symbol of first kind that represents the Levi-Civita connection for the given metric.

      @@ -1979,7 +1979,7 @@

      Base Class Reference
      -sympy.diffgeom.metric_to_Christoffel_2nd(expr)[source]
      +sympy.diffgeom.metric_to_Christoffel_2nd(expr)[source]

      Return the nested list of Christoffel symbols for the given metric. This returns the Christoffel symbol of second kind that represents the Levi-Civita connection for the given metric.

      @@ -1999,7 +1999,7 @@

      Base Class Reference
      -sympy.diffgeom.metric_to_Riemann_components(expr)[source]
      +sympy.diffgeom.metric_to_Riemann_components(expr)[source]

      Return the components of the Riemann tensor expressed in a given basis.

      Given a metric it calculates the components of the Riemann tensor in the canonical basis of the coordinate system in which the metric expression is @@ -2027,7 +2027,7 @@

      Base Class Reference
      -sympy.diffgeom.metric_to_Ricci_components(expr)[source]
      +sympy.diffgeom.metric_to_Ricci_components(expr)[source]

      Return the components of the Ricci tensor expressed in a given basis.

      Given a metric it calculates the components of the Ricci tensor in the canonical basis of the coordinate system in which the metric expression is diff --git a/dev/modules/discrete.html b/dev/modules/discrete.html index 36b96847acb..23c913cb1d4 100644 --- a/dev/modules/discrete.html +++ b/dev/modules/discrete.html @@ -824,7 +824,7 @@

      Discrete

      Fast Fourier Transform

      -sympy.discrete.transforms.fft(seq, dps=None)[source]
      +sympy.discrete.transforms.fft(seq, dps=None)[source]

      Performs the Discrete Fourier Transform (DFT) in the complex domain.

      The sequence is automatically padded to the right with zeros, as the radix-2 FFT requires the number of sample points to be a power of 2.

      @@ -879,7 +879,7 @@

      Fast Fourier Transform
      -sympy.discrete.transforms.ifft(seq, dps=None)[source]
      +sympy.discrete.transforms.ifft(seq, dps=None)[source]

      Performs the Discrete Fourier Transform (DFT) in the complex domain.

      The sequence is automatically padded to the right with zeros, as the radix-2 FFT requires the number of sample points to be a power of 2.

      @@ -937,7 +937,7 @@

      Fast Fourier TransformNumber Theoretic Transform

      -sympy.discrete.transforms.ntt(seq, prime)[source]
      +sympy.discrete.transforms.ntt(seq, prime)[source]

      Performs the Number Theoretic Transform (NTT), which specializes the Discrete Fourier Transform (DFT) over quotient ring \(Z/pZ\) for prime \(p\) instead of complex numbers \(C\).

      @@ -987,7 +987,7 @@

      Number Theoretic Transform
      -sympy.discrete.transforms.intt(seq, prime)[source]
      +sympy.discrete.transforms.intt(seq, prime)[source]

      Performs the Number Theoretic Transform (NTT), which specializes the Discrete Fourier Transform (DFT) over quotient ring \(Z/pZ\) for prime \(p\) instead of complex numbers \(C\).

      @@ -1040,7 +1040,7 @@

      Number Theoretic Transform

      -sympy.discrete.transforms.fwht(seq)[source]
      +sympy.discrete.transforms.fwht(seq)[source]

      Performs the Walsh Hadamard Transform (WHT), and uses Hadamard ordering for the sequence.

      The sequence is automatically padded to the right with zeros, as the @@ -1082,7 +1082,7 @@

      Fast Walsh Hadamard Transform
      -sympy.discrete.transforms.ifwht(seq)[source]
      +sympy.discrete.transforms.ifwht(seq)[source]

      Performs the Walsh Hadamard Transform (WHT), and uses Hadamard ordering for the sequence.

      The sequence is automatically padded to the right with zeros, as the @@ -1127,7 +1127,7 @@

      Fast Walsh Hadamard Transform

      -sympy.discrete.transforms.mobius_transform(seq, subset=True)[source]
      +sympy.discrete.transforms.mobius_transform(seq, subset=True)[source]

      Performs the Mobius Transform for subset lattice with indices of sequence as bitmasks.

      The indices of each argument, considered as bit strings, correspond @@ -1195,7 +1195,7 @@

      Möbius Transform
      -sympy.discrete.transforms.inverse_mobius_transform(seq, subset=True)[source]
      +sympy.discrete.transforms.inverse_mobius_transform(seq, subset=True)[source]

      Performs the Mobius Transform for subset lattice with indices of sequence as bitmasks.

      The indices of each argument, considered as bit strings, correspond @@ -1286,7 +1286,7 @@

      Convolutionsubset=None,

      -)[source] +)[source]

      Performs convolution by determining the type of desired convolution using hints.

      Exactly one of dps, prime, dyadic, subset arguments @@ -1360,7 +1360,7 @@

      Convolution

      -sympy.discrete.convolutions.convolution_fft(a, b, dps=None)[source]
      +sympy.discrete.convolutions.convolution_fft(a, b, dps=None)[source]

      Performs linear convolution using Fast Fourier Transform.

      Parameters:
      @@ -1405,7 +1405,7 @@

      Convolution using Fast Fourier Transform

      -sympy.discrete.convolutions.convolution_ntt(a, b, prime)[source]
      +sympy.discrete.convolutions.convolution_ntt(a, b, prime)[source]

      Performs linear convolution using Number Theoretic Transform.

      Parameters:
      @@ -1448,7 +1448,7 @@

      Convolution using Number Theoretic Transform

      -sympy.discrete.convolutions.convolution_fwht(a, b)[source]
      +sympy.discrete.convolutions.convolution_fwht(a, b)[source]

      Performs dyadic (bitwise-XOR) convolution using Fast Walsh Hadamard Transform.

      The convolution is automatically padded to the right with zeros, as the @@ -1499,7 +1499,7 @@

      Convolution using Fast Walsh Hadamard Transform

      -sympy.discrete.convolutions.convolution_subset(a, b)[source]
      +sympy.discrete.convolutions.convolution_subset(a, b)[source]

      Performs Subset Convolution of given sequences.

      The indices of each argument, considered as bit strings, correspond to subsets of a finite set.

      @@ -1546,7 +1546,7 @@

      Subset Convolution

      -sympy.discrete.convolutions.covering_product(a, b)[source]
      +sympy.discrete.convolutions.covering_product(a, b)[source]

      Returns the covering product of given sequences.

      The indices of each argument, considered as bit strings, correspond to subsets of a finite set.

      @@ -1595,7 +1595,7 @@

      Covering Product

      -sympy.discrete.convolutions.intersecting_product(a, b)[source]
      +sympy.discrete.convolutions.intersecting_product(a, b)[source]

      Returns the intersecting product of given sequences.

      The indices of each argument, considered as bit strings, correspond to subsets of a finite set.

      diff --git a/dev/modules/functions/combinatorial.html b/dev/modules/functions/combinatorial.html index c9bf76b1526..ad6fda6c030 100644 --- a/dev/modules/functions/combinatorial.html +++ b/dev/modules/functions/combinatorial.html @@ -806,7 +806,7 @@
      Documentation Version

      This module implements various combinatorial functions.

      -class sympy.functions.combinatorial.numbers.bell(n, k_sym=None, symbols=None)[source]
      +class sympy.functions.combinatorial.numbers.bell(n, k_sym=None, symbols=None)[source]

      Bell numbers / Bell polynomials

      The Bell numbers satisfy \(B_0 = 1\) and

      @@ -880,7 +880,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.bernoulli(n, x=None)[source]
      +class sympy.functions.combinatorial.numbers.bernoulli(n, x=None)[source]

      Bernoulli numbers / Bernoulli polynomials / Bernoulli function

      The Bernoulli numbers are a sequence of rational numbers defined by \(B_0 = 1\) and the recursive relation (\(n > 0\)):

      @@ -998,7 +998,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.factorials.binomial(n, k)[source]
      +class sympy.functions.combinatorial.factorials.binomial(n, k)[source]

      Implementation of the binomial coefficient. It can be defined in two ways depending on its desired interpretation:

      @@ -1107,7 +1107,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.catalan(n)[source]
      +class sympy.functions.combinatorial.numbers.catalan(n)[source]

      Catalan numbers

      The \(n^{th}\) catalan number is given by:

      @@ -1202,7 +1202,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.euler(n, x=None)[source]
      +class sympy.functions.combinatorial.numbers.euler(n, x=None)[source]

      Euler numbers / Euler polynomials / Euler function

      The Euler numbers are given by:

      @@ -1299,7 +1299,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.factorials.factorial(n)[source]
      +class sympy.functions.combinatorial.factorials.factorial(n)[source]

      Implementation of factorial function over nonnegative integers. By convention (consistent with the gamma function and the binomial coefficients), factorial of a negative integer is complex infinity.

      @@ -1351,7 +1351,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.factorials.subfactorial(arg)[source]
      +class sympy.functions.combinatorial.factorials.subfactorial(arg)[source]

      The subfactorial counts the derangements of \(n\) items and is defined for non-negative integers as:

      @@ -1399,7 +1399,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.factorials.factorial2(arg)[source]
      +class sympy.functions.combinatorial.factorials.factorial2(arg)[source]

      The double factorial \(n!!\), not to be confused with \((n!)!\)

      The double factorial is defined for nonnegative integers and for odd negative integers as:

      @@ -1440,7 +1440,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.factorials.FallingFactorial(x, k)[source]
      +class sympy.functions.combinatorial.factorials.FallingFactorial(x, k)[source]

      Falling factorial (related to rising factorial) is a double valued function arising in concrete mathematics, hypergeometric functions and series expansions. It is defined by

      @@ -1510,7 +1510,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.fibonacci(n, sym=None)[source]
      +class sympy.functions.combinatorial.numbers.fibonacci(n, sym=None)[source]

      Fibonacci numbers / Fibonacci polynomials

      The Fibonacci numbers are the integer sequence defined by the initial terms \(F_0 = 0\), \(F_1 = 1\) and the two-term recurrence @@ -1557,7 +1557,7 @@

      Documentation Version
      -class sympy.functions.combinatorial.numbers.tribonacci(n, sym=None)[source]
      +class sympy.functions.combinatorial.numbers.tribonacci(n, sym=None)[source]

      Tribonacci numbers / Tribonacci polynomials

      The Tribonacci numbers are the integer sequence defined by the initial terms \(T_0 = 0\), \(T_1 = 1\), \(T_2 = 1\) and the three-term @@ -1602,7 +1602,7 @@

      Documentation Version
      -class sympy.functions.combinatorial.numbers.harmonic(n, m=None)[source]
      +class sympy.functions.combinatorial.numbers.harmonic(n, m=None)[source]

      Harmonic numbers

      The nth harmonic number is given by \(\operatorname{H}_{n} = 1 + \frac{1}{2} + \frac{1}{3} + \ldots + \frac{1}{n}\).

      @@ -1753,7 +1753,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.lucas(n)[source]
      +class sympy.functions.combinatorial.numbers.lucas(n)[source]

      Lucas numbers

      Lucas numbers satisfy a recurrence relation similar to that of the Fibonacci sequence, in which each term is the sum of the @@ -1789,7 +1789,7 @@

      Documentation Version
      -class sympy.functions.combinatorial.numbers.genocchi(n, x=None)[source]
      +class sympy.functions.combinatorial.numbers.genocchi(n, x=None)[source]

      Genocchi numbers / Genocchi polynomials / Genocchi function

      The Genocchi numbers are a sequence of integers \(G_n\) that satisfy the relation:

      @@ -1848,7 +1848,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.andre(n)[source]
      +class sympy.functions.combinatorial.numbers.andre(n)[source]

      Andre numbers / Andre function

      The Andre number \(\mathcal{A}_n\) is Luschny’s name for half the number of alternating permutations on \(n\) elements, where a permutation is alternating @@ -1917,7 +1917,7 @@

      Documentation Version
      -class sympy.functions.combinatorial.numbers.partition(n)[source]
      +class sympy.functions.combinatorial.numbers.partition(n)[source]

      Partition numbers

      The Partition numbers are a sequence of integers \(p_n\) that represent the number of distinct ways of representing \(n\) as a sum of natural numbers @@ -1954,7 +1954,7 @@

      Documentation Version
      -class sympy.functions.combinatorial.numbers.divisor_sigma(n, k=1)[source]
      +class sympy.functions.combinatorial.numbers.divisor_sigma(n, k=1)[source]

      Calculate the divisor function \(\sigma_k(n)\) for positive integer n

      divisor_sigma(n, k) is equal to sum([x**k for x in divisors(n)])

      If n’s prime factorization is:

      @@ -1995,7 +1995,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.udivisor_sigma(n, k=1)[source]
      +class sympy.functions.combinatorial.numbers.udivisor_sigma(n, k=1)[source]

      Calculate the unitary divisor function \(\sigma_k^*(n)\) for positive integer n

      udivisor_sigma(n, k) is equal to sum([x**k for x in udivisors(n)])

      If n’s prime factorization is:

      @@ -2046,7 +2046,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.legendre_symbol(a, p)[source]
      +class sympy.functions.combinatorial.numbers.legendre_symbol(a, p)[source]

      Returns the Legendre symbol \((a / p)\).

      For an integer a and an odd prime p, the Legendre symbol is defined as

      @@ -2074,7 +2074,7 @@
      Documentation Version
      -class sympy.functions.combinatorial.numbers.jacobi_symbol(m, n)[source]
      +class sympy.functions.combinatorial.numbers.jacobi_symbol(m, n)[source]

      Returns the Jacobi symbol \((m / n)\).

      For any integer m and any positive odd integer n the Jacobi symbol is defined as the product of the Legendre symbols corresponding to the @@ -2123,7 +2123,7 @@

      Documentation Version
      -class sympy.functions.combinatorial.numbers.kronecker_symbol(a, n)[source]
      +class sympy.functions.combinatorial.numbers.kronecker_symbol(a, n)[source]

      Returns the Kronecker symbol \((a / n)\).

      Examples

      >>> from sympy.functions.combinatorial.numbers import kronecker_symbol
      @@ -2148,7 +2148,7 @@ 
      Documentation Version
      -class sympy.functions.combinatorial.numbers.mobius(n)[source]
      +class sympy.functions.combinatorial.numbers.mobius(n)[source]

      Mobius function maps natural number to {-1, 0, 1}

      It is defined as follows:
        @@ -2203,7 +2203,7 @@
        Documentation Version
        -class sympy.functions.combinatorial.numbers.primenu(n)[source]
        +class sympy.functions.combinatorial.numbers.primenu(n)[source]

        Calculate the number of distinct prime factors for a positive integer n.

        If n’s prime factorization is:

        @@ -2242,7 +2242,7 @@
        Documentation Version
        -class sympy.functions.combinatorial.numbers.primeomega(n)[source]
        +class sympy.functions.combinatorial.numbers.primeomega(n)[source]

        Calculate the number of prime factors counting multiplicities for a positive integer n.

        If n’s prime factorization is:

        @@ -2282,7 +2282,7 @@
        Documentation Version
        -class sympy.functions.combinatorial.numbers.totient(n)[source]
        +class sympy.functions.combinatorial.numbers.totient(n)[source]

        Calculate the Euler totient function phi(n)

        totient(n) or \(\phi(n)\) is the number of positive integers \(\leq\) n that are relatively prime to n.

        @@ -2319,7 +2319,7 @@
        Documentation Version
        -class sympy.functions.combinatorial.numbers.reduced_totient(n)[source]
        +class sympy.functions.combinatorial.numbers.reduced_totient(n)[source]

        Calculate the Carmichael reduced totient function lambda(n)

        reduced_totient(n) or \(\lambda(n)\) is the smallest m > 0 such that \(k^m \equiv 1 \mod n\) for all k relatively prime to n.

        @@ -2356,7 +2356,7 @@
        Documentation Version
        -class sympy.functions.combinatorial.numbers.primepi(n)[source]
        +class sympy.functions.combinatorial.numbers.primepi(n)[source]

        Represents the prime counting function pi(n) = the number of prime numbers less than or equal to n.

        Examples

        @@ -2399,12 +2399,12 @@
        Documentation Version
        -class sympy.functions.combinatorial.factorials.MultiFactorial(*args)[source]
        +class sympy.functions.combinatorial.factorials.MultiFactorial(*args)[source]
        -class sympy.functions.combinatorial.factorials.RisingFactorial(x, k)[source]
        +class sympy.functions.combinatorial.factorials.RisingFactorial(x, k)[source]

        Rising factorial (also called Pochhammer symbol [R268]) is a double valued function arising in concrete mathematics, hypergeometric functions and series expansions. It is defined by:

        @@ -2471,7 +2471,7 @@
        Documentation Version
        -sympy.functions.combinatorial.numbers.stirling(n, k, d=None, kind=2, signed=False)[source]
        +sympy.functions.combinatorial.numbers.stirling(n, k, d=None, kind=2, signed=False)[source]

        Return Stirling number \(S(n, k)\) of the first or second (default) kind.

        The sum of all Stirling numbers of the second kind for \(k = 1\) through \(n\) is bell(n). The recurrence relationship for these numbers @@ -2579,7 +2579,7 @@

        Enumeration
        -sympy.functions.combinatorial.numbers.nC(n, k=None, replacement=False)[source]
        +sympy.functions.combinatorial.numbers.nC(n, k=None, replacement=False)[source]

        Return the number of combinations of n items taken k at a time.

        Possible values for n:

        @@ -2645,7 +2645,7 @@

        Enumeration
        -sympy.functions.combinatorial.numbers.nP(n, k=None, replacement=False)[source]
        +sympy.functions.combinatorial.numbers.nP(n, k=None, replacement=False)[source]

        Return the number of permutations of n items taken k at a time.

        Possible values for n:

        @@ -2703,7 +2703,7 @@

        Enumeration
        -sympy.functions.combinatorial.numbers.nT(n, k=None)[source]
        +sympy.functions.combinatorial.numbers.nT(n, k=None)[source]

        Return the number of k-sized partitions of n items.

        Possible values for n:

        diff --git a/dev/modules/functions/elementary.html b/dev/modules/functions/elementary.html index 68c05b7ca77..2cdca1324cc 100644 --- a/dev/modules/functions/elementary.html +++ b/dev/modules/functions/elementary.html @@ -809,7 +809,7 @@
        Documentation Version

        Complex Functions

        -class sympy.functions.elementary.complexes.re(arg)[source]
        +class sympy.functions.elementary.complexes.re(arg)[source]

        Returns real part of expression. This function performs only elementary analysis and so it will fail to decompose properly more complicated expressions. If completely simplified result @@ -850,7 +850,7 @@

        Complex Functions
        -as_real_imag(deep=True, **hints)[source]
        +as_real_imag(deep=True, **hints)[source]

        Returns the real number with a zero imaginary part.

        @@ -858,7 +858,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.im(arg)[source]
        +class sympy.functions.elementary.complexes.im(arg)[source]

        Returns imaginary part of expression. This function performs only elementary analysis and so it will fail to decompose properly more complicated expressions. If completely simplified result is needed then @@ -899,7 +899,7 @@

        Complex Functions
        -as_real_imag(deep=True, **hints)[source]
        +as_real_imag(deep=True, **hints)[source]

        Return the imaginary part with a zero real part.

        @@ -907,7 +907,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.sign(arg)[source]
        +class sympy.functions.elementary.complexes.sign(arg)[source]

        Returns the complex sign of an expression:

        Parameters:
        @@ -965,7 +965,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.Abs(arg)[source]
        +class sympy.functions.elementary.complexes.Abs(arg)[source]

        Return the absolute value of the argument.

        Parameters:
        @@ -1018,7 +1018,7 @@

        Complex Functions
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Get the first derivative of the argument to Abs().

        @@ -1026,7 +1026,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.arg(arg)[source]
        +class sympy.functions.elementary.complexes.arg(arg)[source]

        Returns the argument (in radians) of a complex number. The argument is evaluated in consistent convention with atan2 where the branch-cut is taken along the negative real axis and arg(z) is in the interval @@ -1075,7 +1075,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.conjugate(arg)[source]
        +class sympy.functions.elementary.complexes.conjugate(arg)[source]

        Returns the complex conjugate [R276] of an argument. In mathematics, the complex conjugate of a complex number is given by changing the sign of the imaginary part.

        @@ -1123,7 +1123,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.polar_lift(arg)[source]
        +class sympy.functions.elementary.complexes.polar_lift(arg)[source]

        Lift argument to the Riemann surface of the logarithm, using the standard branch.

        @@ -1162,7 +1162,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.periodic_argument(ar, period)[source]
        +class sympy.functions.elementary.complexes.periodic_argument(ar, period)[source]

        Represent the argument on a quotient of the Riemann surface of the logarithm. That is, given a period \(P\), always return a value in \((-P/2, P/2]\), by using \(\exp(PI) = 1\).

        @@ -1208,7 +1208,7 @@

        Complex Functions
        -class sympy.functions.elementary.complexes.principal_branch(x, period)[source]
        +class sympy.functions.elementary.complexes.principal_branch(x, period)[source]

        Represent a polar number reduced to its principal branch on a quotient of the Riemann surface of the logarithm.

        @@ -1256,7 +1256,7 @@

        Trigonometric

        Trigonometric Functions

        -class sympy.functions.elementary.trigonometric.sin(arg)[source]
        +class sympy.functions.elementary.trigonometric.sin(arg)[source]

        The sine function.

        Returns the sine of x (measured in radians).

        Explanation

        @@ -1308,7 +1308,7 @@

        Trigonometric
        -class sympy.functions.elementary.trigonometric.cos(arg)[source]
        +class sympy.functions.elementary.trigonometric.cos(arg)[source]

        The cosine function.

        Returns the cosine of x (measured in radians).

        Explanation

        @@ -1353,7 +1353,7 @@

        Trigonometric
        -class sympy.functions.elementary.trigonometric.tan(arg)[source]
        +class sympy.functions.elementary.trigonometric.tan(arg)[source]

        The tangent function.

        Returns the tangent of x (measured in radians).

        Explanation

        @@ -1390,7 +1390,7 @@

        Trigonometric
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1398,7 +1398,7 @@

        Trigonometric
        -class sympy.functions.elementary.trigonometric.cot(arg)[source]
        +class sympy.functions.elementary.trigonometric.cot(arg)[source]

        The cotangent function.

        Returns the cotangent of x (measured in radians).

        Explanation

        @@ -1435,7 +1435,7 @@

        Trigonometric
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1443,7 +1443,7 @@

        Trigonometric
        -class sympy.functions.elementary.trigonometric.sec(arg)[source]
        +class sympy.functions.elementary.trigonometric.sec(arg)[source]

        The secant function.

        Returns the secant of x (measured in radians).

        Explanation

        @@ -1480,7 +1480,7 @@

        Trigonometric
        -class sympy.functions.elementary.trigonometric.csc(arg)[source]
        +class sympy.functions.elementary.trigonometric.csc(arg)[source]

        The cosecant function.

        Returns the cosecant of x (measured in radians).

        Explanation

        @@ -1517,7 +1517,7 @@

        Trigonometric
        -class sympy.functions.elementary.trigonometric.sinc(arg)[source]
        +class sympy.functions.elementary.trigonometric.sinc(arg)[source]

        Represents an unnormalized sinc function:

        @@ -1582,7 +1582,7 @@

        Trigonometric

        -class sympy.functions.elementary.trigonometric.asin(arg)[source]
        +class sympy.functions.elementary.trigonometric.asin(arg)[source]

        The inverse sine function.

        Returns the arcsine of x in radians.

        Explanation

        @@ -1623,7 +1623,7 @@

        Trigonometric Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1631,7 +1631,7 @@

        Trigonometric Inverses
        -class sympy.functions.elementary.trigonometric.acos(arg)[source]
        +class sympy.functions.elementary.trigonometric.acos(arg)[source]

        The inverse cosine function.

        Explanation

        Returns the arc cosine of x (measured in radians).

        @@ -1672,7 +1672,7 @@

        Trigonometric Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1680,7 +1680,7 @@

        Trigonometric Inverses
        -class sympy.functions.elementary.trigonometric.atan(arg)[source]
        +class sympy.functions.elementary.trigonometric.atan(arg)[source]

        The inverse tangent function.

        Returns the arc tangent of x (measured in radians).

        Explanation

        @@ -1718,7 +1718,7 @@

        Trigonometric Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1726,7 +1726,7 @@

        Trigonometric Inverses
        -class sympy.functions.elementary.trigonometric.acot(arg)[source]
        +class sympy.functions.elementary.trigonometric.acot(arg)[source]

        The inverse cotangent function.

        Returns the arc cotangent of x (measured in radians).

        Explanation

        @@ -1764,7 +1764,7 @@

        Trigonometric Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1772,7 +1772,7 @@

        Trigonometric Inverses
        -class sympy.functions.elementary.trigonometric.asec(arg)[source]
        +class sympy.functions.elementary.trigonometric.asec(arg)[source]

        The inverse secant function.

        Returns the arc secant of x (measured in radians).

        Explanation

        @@ -1833,7 +1833,7 @@

        Trigonometric Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1841,7 +1841,7 @@

        Trigonometric Inverses
        -class sympy.functions.elementary.trigonometric.acsc(arg)[source]
        +class sympy.functions.elementary.trigonometric.acsc(arg)[source]

        The inverse cosecant function.

        Returns the arc cosecant of x (measured in radians).

        Explanation

        @@ -1883,7 +1883,7 @@

        Trigonometric Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -1891,7 +1891,7 @@

        Trigonometric Inverses
        -class sympy.functions.elementary.trigonometric.atan2(y, x)[source]
        +class sympy.functions.elementary.trigonometric.atan2(y, x)[source]

        The function atan2(y, x) computes \(\operatorname{atan}(y/x)\) taking two arguments \(y\) and \(x\). Signs of both \(y\) and \(x\) are considered to determine the appropriate quadrant of \(\operatorname{atan}(y/x)\). @@ -2002,7 +2002,7 @@

        Hyperbolic

        -class sympy.functions.elementary.hyperbolic.HyperbolicFunction(*args)[source]
        +class sympy.functions.elementary.hyperbolic.HyperbolicFunction(*args)[source]

        Base class for hyperbolic functions.

        See also

        @@ -2012,7 +2012,7 @@

        Hyperbolic Functions
        -class sympy.functions.elementary.hyperbolic.sinh(arg)[source]
        +class sympy.functions.elementary.hyperbolic.sinh(arg)[source]

        sinh(x) is the hyperbolic sine of x.

        The hyperbolic sine function is \(\frac{e^x - e^{-x}}{2}\).

        Examples

        @@ -2028,25 +2028,25 @@

        Hyperbolic Functions
        -as_real_imag(deep=True, **hints)[source]
        +as_real_imag(deep=True, **hints)[source]

        Returns this function as a complex coordinate.

        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of this function.

        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        -static taylor_term(n, x, *previous_terms)[source]
        +static taylor_term(n, x, *previous_terms)[source]

        Returns the next term in the Taylor series expansion.

        @@ -2054,7 +2054,7 @@

        Hyperbolic Functions
        -class sympy.functions.elementary.hyperbolic.cosh(arg)[source]
        +class sympy.functions.elementary.hyperbolic.cosh(arg)[source]

        cosh(x) is the hyperbolic cosine of x.

        The hyperbolic cosine function is \(\frac{e^x + e^{-x}}{2}\).

        Examples

        @@ -2072,7 +2072,7 @@

        Hyperbolic Functions
        -class sympy.functions.elementary.hyperbolic.tanh(arg)[source]
        +class sympy.functions.elementary.hyperbolic.tanh(arg)[source]

        tanh(x) is the hyperbolic tangent of x.

        The hyperbolic tangent function is \(\frac{\sinh(x)}{\cosh(x)}\).

        Examples

        @@ -2088,7 +2088,7 @@

        Hyperbolic Functions
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2096,7 +2096,7 @@

        Hyperbolic Functions
        -class sympy.functions.elementary.hyperbolic.coth(arg)[source]
        +class sympy.functions.elementary.hyperbolic.coth(arg)[source]

        coth(x) is the hyperbolic cotangent of x.

        The hyperbolic cotangent function is \(\frac{\cosh(x)}{\sinh(x)}\).

        Examples

        @@ -2112,7 +2112,7 @@

        Hyperbolic Functions
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2120,7 +2120,7 @@

        Hyperbolic Functions
        -class sympy.functions.elementary.hyperbolic.sech(arg)[source]
        +class sympy.functions.elementary.hyperbolic.sech(arg)[source]

        sech(x) is the hyperbolic secant of x.

        The hyperbolic secant function is \(\frac{2}{e^x + e^{-x}}\)

        Examples

        @@ -2138,7 +2138,7 @@

        Hyperbolic Functions
        -class sympy.functions.elementary.hyperbolic.csch(arg)[source]
        +class sympy.functions.elementary.hyperbolic.csch(arg)[source]

        csch(x) is the hyperbolic cosecant of x.

        The hyperbolic cosecant function is \(\frac{2}{e^x - e^{-x}}\)

        Examples

        @@ -2154,13 +2154,13 @@

        Hyperbolic Functions
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of this function

        -static taylor_term(n, x, *previous_terms)[source]
        +static taylor_term(n, x, *previous_terms)[source]

        Returns the next term in the Taylor series expansion

        @@ -2171,7 +2171,7 @@

        Hyperbolic FunctionsHyperbolic Inverses

        -class sympy.functions.elementary.hyperbolic.asinh(arg)[source]
        +class sympy.functions.elementary.hyperbolic.asinh(arg)[source]

        asinh(x) is the inverse hyperbolic sine of x.

        The inverse hyperbolic sine function.

        Examples

        @@ -2189,7 +2189,7 @@

        Hyperbolic Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2197,7 +2197,7 @@

        Hyperbolic Inverses
        -class sympy.functions.elementary.hyperbolic.acosh(arg)[source]
        +class sympy.functions.elementary.hyperbolic.acosh(arg)[source]

        acosh(x) is the inverse hyperbolic cosine of x.

        The inverse hyperbolic cosine function.

        Examples

        @@ -2215,7 +2215,7 @@

        Hyperbolic Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2223,7 +2223,7 @@

        Hyperbolic Inverses
        -class sympy.functions.elementary.hyperbolic.atanh(arg)[source]
        +class sympy.functions.elementary.hyperbolic.atanh(arg)[source]

        atanh(x) is the inverse hyperbolic tangent of x.

        The inverse hyperbolic tangent function.

        Examples

        @@ -2239,7 +2239,7 @@

        Hyperbolic Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2247,7 +2247,7 @@

        Hyperbolic Inverses
        -class sympy.functions.elementary.hyperbolic.acoth(arg)[source]
        +class sympy.functions.elementary.hyperbolic.acoth(arg)[source]

        acoth(x) is the inverse hyperbolic cotangent of x.

        The inverse hyperbolic cotangent function.

        Examples

        @@ -2263,7 +2263,7 @@

        Hyperbolic Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2271,7 +2271,7 @@

        Hyperbolic Inverses
        -class sympy.functions.elementary.hyperbolic.asech(arg)[source]
        +class sympy.functions.elementary.hyperbolic.asech(arg)[source]

        asech(x) is the inverse hyperbolic secant of x.

        The inverse hyperbolic secant function.

        Examples

        @@ -2312,7 +2312,7 @@

        Hyperbolic Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2320,7 +2320,7 @@

        Hyperbolic Inverses
        -class sympy.functions.elementary.hyperbolic.acsch(arg)[source]
        +class sympy.functions.elementary.hyperbolic.acsch(arg)[source]

        acsch(x) is the inverse hyperbolic cosecant of x.

        The inverse hyperbolic cosecant function.

        Examples

        @@ -2361,7 +2361,7 @@

        Hyperbolic Inverses
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2373,7 +2373,7 @@

        Hyperbolic Inverses

        -class sympy.functions.elementary.integers.ceiling(arg)[source]
        +class sympy.functions.elementary.integers.ceiling(arg)[source]

        Ceiling is a univariate function which returns the smallest integer value not less than its argument. This implementation generalizes ceiling to complex numbers by taking the ceiling of the @@ -2413,7 +2413,7 @@

        Integer Functions
        -class sympy.functions.elementary.integers.floor(arg)[source]
        +class sympy.functions.elementary.integers.floor(arg)[source]

        Floor is a univariate function which returns the largest integer value not greater than its argument. This implementation generalizes floor to complex numbers by taking the floor of the @@ -2453,13 +2453,13 @@

        Integer Functions
        -class sympy.functions.elementary.integers.RoundFunction(arg)[source]
        +class sympy.functions.elementary.integers.RoundFunction(arg)[source]

        Abstract base class for rounding functions.

        -class sympy.functions.elementary.integers.frac(arg)[source]
        +class sympy.functions.elementary.integers.frac(arg)[source]

        Represents the fractional part of x

        For real numbers it is defined [R328] as

        @@ -2516,7 +2516,7 @@

        Integer Functions

        -class sympy.functions.elementary.exponential.exp(arg)[source]
        +class sympy.functions.elementary.exponential.exp(arg)[source]

        The exponential function, \(e^x\).

        Parameters:
        @@ -2540,7 +2540,7 @@

        Exponential
        -as_real_imag(deep=True, **hints)[source]
        +as_real_imag(deep=True, **hints)[source]

        Returns this function as a 2-tuple representing a complex number.

        Examples

        >>> from sympy import exp, I
        @@ -2569,13 +2569,13 @@ 

        Exponential
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of this function.

        -static taylor_term(n, x, *previous_terms)[source]
        +static taylor_term(n, x, *previous_terms)[source]

        Calculates the next term in the Taylor series expansion.

        @@ -2583,7 +2583,7 @@

        Exponential
        -class sympy.functions.elementary.exponential.LambertW(x, k=None)[source]
        +class sympy.functions.elementary.exponential.LambertW(x, k=None)[source]

        The Lambert W function \(W(z)\) is defined as the inverse function of \(w \exp(w)\) [R330].

        Explanation

        @@ -2616,7 +2616,7 @@

        Exponential
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Return the first derivative of this function.

        @@ -2624,7 +2624,7 @@

        Exponential
        -class sympy.functions.elementary.exponential.log(arg, base=None)[source]
        +class sympy.functions.elementary.exponential.log(arg, base=None)[source]

        The natural logarithm function \(\ln(x)\) or \(\log(x)\).

        Explanation

        Logarithms are taken with the natural base, \(e\). To get @@ -2650,7 +2650,7 @@

        Exponential
        -as_real_imag(deep=True, **hints)[source]
        +as_real_imag(deep=True, **hints)[source]

        Returns this function as a complex coordinate.

        Examples

        >>> from sympy import I, log
        @@ -2669,19 +2669,19 @@ 

        Exponential
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of the function.

        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns \(e^x\), the inverse function of \(\log(x)\).

        -static taylor_term(n, x, *previous_terms)[source]
        +static taylor_term(n, x, *previous_terms)[source]

        Returns the next term in the Taylor series expansion of \(\log(1+x)\).

        @@ -2689,7 +2689,7 @@

        Exponential
        -class sympy.functions.elementary.exponential.exp_polar(*args)[source]
        +class sympy.functions.elementary.exponential.exp_polar(*args)[source]

        Represent a polar number (see g-function Sphinx documentation).

        Explanation

        exp_polar represents the function @@ -2723,7 +2723,7 @@

        Exponential

        -class sympy.functions.elementary.piecewise.ExprCondPair(expr, cond)[source]
        +class sympy.functions.elementary.piecewise.ExprCondPair(expr, cond)[source]

        Represents an expression, condition pair.

        @@ -2741,7 +2741,7 @@

        Piecewise
        -class sympy.functions.elementary.piecewise.Piecewise(*_args)[source]
        +class sympy.functions.elementary.piecewise.Piecewise(*_args)[source]

        Represents a piecewise function.

        Usage:

        @@ -2803,7 +2803,7 @@

        Piecewise
        -_eval_integral(x, _first=True, **kwargs)[source]
        +_eval_integral(x, _first=True, **kwargs)[source]

        Return the indefinite integral of the Piecewise such that subsequent substitution of x with a value will give the value of the integral (not including @@ -2828,7 +2828,7 @@

        Piecewise
        -as_expr_set_pairs(domain=None)[source]
        +as_expr_set_pairs(domain=None)[source]

        Return tuples for each argument of self that give the expression and the interval in which it is valid which is contained within the given domain. @@ -2855,13 +2855,13 @@

        Piecewise
        -doit(**hints)[source]
        +doit(**hints)[source]

        Evaluate this piecewise function.

        -classmethod eval(*_args)[source]
        +classmethod eval(*_args)[source]

        Either return a modified version of the args or, if no modifications were made, return None.

        Modifications that are made here:

        @@ -2889,7 +2889,7 @@

        Piecewise
        -piecewise_integrate(x, **kwargs)[source]
        +piecewise_integrate(x, **kwargs)[source]

        Return the Piecewise with each expression being replaced with its antiderivative. To obtain a continuous antiderivative, use the integrate() function or method.

        @@ -2936,7 +2936,7 @@

        Piecewisedeep=True,

        -)[source] +)[source]

        Rewrite Piecewise with mutually exclusive conditions.

        Parameters:
        @@ -2997,7 +2997,7 @@

        Piecewise
        -sympy.functions.elementary.piecewise.piecewise_fold(expr, evaluate=True)[source]
        +sympy.functions.elementary.piecewise.piecewise_fold(expr, evaluate=True)[source]

        Takes an expression containing a piecewise function and returns the expression in piecewise form. In addition, any ITE conditions are rewritten in negation normal form and simplified.

        @@ -3024,7 +3024,7 @@

        Piecewise

        -class sympy.functions.elementary.miscellaneous.IdentityFunction[source]
        +class sympy.functions.elementary.miscellaneous.IdentityFunction[source]

        The identity function

        Examples

        >>> from sympy import Id, Symbol
        @@ -3037,7 +3037,7 @@ 

        Miscellaneous
        -class sympy.functions.elementary.miscellaneous.Min(*args)[source]
        +class sympy.functions.elementary.miscellaneous.Min(*args)[source]

        Return, if possible, the minimum value of the list. It is named Min and not min to avoid conflicts with the built-in function min.

        @@ -3071,7 +3071,7 @@

        Miscellaneous
        -class sympy.functions.elementary.miscellaneous.Max(*args)[source]
        +class sympy.functions.elementary.miscellaneous.Max(*args)[source]

        Return, if possible, the maximum value of the list.

        When number of arguments is equal one, then return this argument.

        @@ -3157,7 +3157,7 @@

        Miscellaneous
        -sympy.functions.elementary.miscellaneous.root(arg, n, k=0, evaluate=None)[source]
        +sympy.functions.elementary.miscellaneous.root(arg, n, k=0, evaluate=None)[source]

        Returns the k-th n-th root of arg.

        Parameters:
        @@ -3273,7 +3273,7 @@

        Miscellaneous
        -sympy.functions.elementary.miscellaneous.sqrt(arg, evaluate=None)[source]
        +sympy.functions.elementary.miscellaneous.sqrt(arg, evaluate=None)[source]

        Returns the principal square root.

        Parameters:
        @@ -3368,7 +3368,7 @@

        Miscellaneous
        -sympy.functions.elementary.miscellaneous.cbrt(arg, evaluate=None)[source]
        +sympy.functions.elementary.miscellaneous.cbrt(arg, evaluate=None)[source]

        Returns the principal cube root.

        Parameters:
        @@ -3431,7 +3431,7 @@

        Miscellaneous
        -sympy.functions.elementary.miscellaneous.real_root(arg, n=None, evaluate=None)[source]
        +sympy.functions.elementary.miscellaneous.real_root(arg, n=None, evaluate=None)[source]

        Return the real n’th-root of arg if possible.

        Parameters:
        diff --git a/dev/modules/functions/index.html b/dev/modules/functions/index.html index 65a6c6b42d4..21104d35d33 100644 --- a/dev/modules/functions/index.html +++ b/dev/modules/functions/index.html @@ -807,7 +807,7 @@
        Documentation Version
        sympy.core.function.Function.

        -class sympy.core.function.Function(*args)[source]
        +class sympy.core.function.Function(*args)[source]

        Base class for applied mathematical functions.

        It also serves as a constructor for undefined function classes.

        See the Writing Custom Functions guide for details on how to subclass @@ -855,13 +855,13 @@

        Documentation Version
        to create a custom function.

        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of the function.

        -classmethod is_singular(a)[source]
        +classmethod is_singular(a)[source]

        Tests whether the argument is an essential singularity or a branch point, or the functions is non-holomorphic.

        diff --git a/dev/modules/functions/special.html b/dev/modules/functions/special.html index 2d7b91e68fa..396b2e2e7db 100644 --- a/dev/modules/functions/special.html +++ b/dev/modules/functions/special.html @@ -807,7 +807,7 @@
        Documentation Version

        Dirac Delta and Related Discontinuous Functions

        -class sympy.functions.special.delta_functions.DiracDelta(arg, k=0)[source]
        +class sympy.functions.special.delta_functions.DiracDelta(arg, k=0)[source]

        The DiracDelta function and its derivatives.

        Explanation

        DiracDelta is not an ordinary function. It can be rigorously defined either @@ -884,7 +884,7 @@

        Dirac Delta and Related Discontinuous Functions
        -classmethod eval(arg, k=0)[source]
        +classmethod eval(arg, k=0)[source]

        Returns a simplified form or a value of DiracDelta depending on the argument passed by the DiracDelta object.

        @@ -947,7 +947,7 @@

        Dirac Delta and Related Discontinuous Functions
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of a DiracDelta Function.

        Parameters:
        @@ -989,7 +989,7 @@

        Dirac Delta and Related Discontinuous Functions
        -is_simple(x)[source]
        +is_simple(x)[source]

        Tells whether the argument(args[0]) of DiracDelta is a linear expression in x.

        @@ -1026,7 +1026,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.delta_functions.Heaviside(arg, H0=1 / 2)[source]
        +class sympy.functions.special.delta_functions.Heaviside(arg, H0=1 / 2)[source]

        Heaviside step function.

        Explanation

        The Heaviside step function has the following properties:

        @@ -1079,7 +1079,7 @@

        Dirac Delta and Related Discontinuous Functions
        -classmethod eval(arg, H0=1 / 2)[source]
        +classmethod eval(arg, H0=1 / 2)[source]

        Returns a simplified form or a value of Heaviside depending on the argument passed by the Heaviside object.

        @@ -1135,7 +1135,7 @@

        Dirac Delta and Related Discontinuous Functions
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of a Heaviside Function.

        Parameters:
        @@ -1174,7 +1174,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.singularity_functions.SingularityFunction(variable, offset, exponent)[source]
        +class sympy.functions.special.singularity_functions.SingularityFunction(variable, offset, exponent)[source]

        Singularity functions are a class of discontinuous functions.

        Explanation

        Singularity functions take a variable, an offset, and an exponent as @@ -1247,7 +1247,7 @@

        Dirac Delta and Related Discontinuous Functionsexponent,

        -)[source] +)[source]

        Returns a simplified form or a value of Singularity Function depending on the argument passed by the object.

        Explanation

        @@ -1285,7 +1285,7 @@

        Dirac Delta and Related Discontinuous Functions
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Returns the first derivative of a DiracDelta Function.

        Explanation

        The difference between diff() and fdiff() is: diff() is the @@ -1303,7 +1303,7 @@

        Dirac Delta and Related Discontinuous Functions

        Gamma, Beta and Related Functions

        -class sympy.functions.special.gamma_functions.gamma(arg)[source]
        +class sympy.functions.special.gamma_functions.gamma(arg)[source]

        The gamma function

        @@ -1396,7 +1396,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.gamma_functions.loggamma(z)[source]
        +class sympy.functions.special.gamma_functions.loggamma(z)[source]

        The loggamma function implements the logarithm of the gamma function (i.e., \(\log\Gamma(x)\)).

        Examples

        @@ -1524,7 +1524,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.gamma_functions.polygamma(n, z)[source]
        +class sympy.functions.special.gamma_functions.polygamma(n, z)[source]

        The function polygamma(n, z) returns log(gamma(z)).diff(n + 1).

        Explanation

        It is a meromorphic function on \(\mathbb{C}\) and defined as the \((n+1)\)-th @@ -1653,7 +1653,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.gamma_functions.digamma(z)[source]
        +class sympy.functions.special.gamma_functions.digamma(z)[source]

        The digamma function is the first derivative of the loggamma function

        @@ -1717,7 +1717,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.gamma_functions.trigamma(z)[source]
        +class sympy.functions.special.gamma_functions.trigamma(z)[source]

        The trigamma function is the second derivative of the loggamma function

        @@ -1780,7 +1780,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.gamma_functions.uppergamma(a, z)[source]
        +class sympy.functions.special.gamma_functions.uppergamma(a, z)[source]

        The upper incomplete gamma function.

        Explanation

        It can be defined as the meromorphic continuation of

        @@ -1866,7 +1866,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.gamma_functions.lowergamma(a, x)[source]
        +class sympy.functions.special.gamma_functions.lowergamma(a, x)[source]

        The lower incomplete gamma function.

        Explanation

        It can be defined as the meromorphic continuation of

        @@ -1939,7 +1939,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.gamma_functions.multigamma(x, p)[source]
        +class sympy.functions.special.gamma_functions.multigamma(x, p)[source]

        The multivariate gamma function is a generalization of the gamma function

        @@ -1999,7 +1999,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.beta_functions.beta(x, y=None)[source]
        +class sympy.functions.special.beta_functions.beta(x, y=None)[source]

        The beta integral is called the Eulerian integral of the first kind by Legendre:

        @@ -2107,7 +2107,7 @@

        Dirac Delta and Related Discontinuous Functions

        Error Functions and Fresnel Integrals

        -class sympy.functions.special.error_functions.erf(arg)[source]
        +class sympy.functions.special.error_functions.erf(arg)[source]

        The Gauss error function.

        Explanation

        This function is defined as:

        @@ -2198,7 +2198,7 @@

        Dirac Delta and Related Discontinuous Functions
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2206,7 +2206,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.erfc(arg)[source]
        +class sympy.functions.special.error_functions.erfc(arg)[source]

        Complementary Error Function.

        Explanation

        The function is defined as:

        @@ -2297,7 +2297,7 @@

        Dirac Delta and Related Discontinuous Functions
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2305,7 +2305,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.erfi(z)[source]
        +class sympy.functions.special.error_functions.erfi(z)[source]

        Imaginary error function.

        Explanation

        The function erfi is defined as:

        @@ -2393,7 +2393,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.erf2(x, y)[source]
        +class sympy.functions.special.error_functions.erf2(x, y)[source]

        Two-argument error function.

        Explanation

        This function is defined as:

        @@ -2468,7 +2468,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.erfinv(z)[source]
        +class sympy.functions.special.error_functions.erfinv(z)[source]

        Inverse Error Function. The erfinv function is defined as:

        @@ -2528,7 +2528,7 @@

        Dirac Delta and Related Discontinuous Functions
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2536,7 +2536,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.erfcinv(z)[source]
        +class sympy.functions.special.error_functions.erfcinv(z)[source]

        Inverse Complementary Error Function. The erfcinv function is defined as:

        @@ -2590,7 +2590,7 @@

        Dirac Delta and Related Discontinuous Functions
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Returns the inverse of this function.

        @@ -2598,7 +2598,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.erf2inv(x, y)[source]
        +class sympy.functions.special.error_functions.erf2inv(x, y)[source]

        Two-argument Inverse error function. The erf2inv function is defined as:

        @@ -2658,13 +2658,13 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.FresnelIntegral(z)[source]
        +class sympy.functions.special.error_functions.FresnelIntegral(z)[source]

        Base class for the Fresnel integrals.

        -class sympy.functions.special.error_functions.fresnels(z)[source]
        +class sympy.functions.special.error_functions.fresnels(z)[source]

        Fresnel integral S.

        Explanation

        This function is defined by

        @@ -2764,7 +2764,7 @@

        Dirac Delta and Related Discontinuous Functions
        -class sympy.functions.special.error_functions.fresnelc(z)[source]
        +class sympy.functions.special.error_functions.fresnelc(z)[source]

        Fresnel integral C.

        Explanation

        This function is defined by

        @@ -2867,7 +2867,7 @@

        Dirac Delta and Related Discontinuous Functions

        -class sympy.functions.special.error_functions.Ei(z)[source]
        +class sympy.functions.special.error_functions.Ei(z)[source]

        The classical exponential integral.

        Explanation

        For use in SymPy, this function is defined as

        @@ -2968,7 +2968,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.error_functions.expint(nu, z)[source]
        +class sympy.functions.special.error_functions.expint(nu, z)[source]

        Generalized exponential integral.

        Explanation

        This function is defined as

        @@ -3084,7 +3084,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -sympy.functions.special.error_functions.E1(z)[source]
        +sympy.functions.special.error_functions.E1(z)[source]

        Classical case of the generalized exponential integral.

        Explanation

        This is equivalent to expint(1, z).

        @@ -3123,7 +3123,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.error_functions.li(z)[source]
        +class sympy.functions.special.error_functions.li(z)[source]

        The classical logarithmic integral.

        Explanation

        For use in SymPy, this function is defined as

        @@ -3240,7 +3240,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.error_functions.Li(z)[source]
        +class sympy.functions.special.error_functions.Li(z)[source]

        The offset logarithmic integral.

        Explanation

        For use in SymPy, this function is defined as

        @@ -3320,7 +3320,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.error_functions.Si(z)[source]
        +class sympy.functions.special.error_functions.Si(z)[source]

        Sine integral.

        Explanation

        This function is defined by

        @@ -3400,7 +3400,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.error_functions.Ci(z)[source]
        +class sympy.functions.special.error_functions.Ci(z)[source]

        Cosine integral.

        Explanation

        This function is defined for positive \(x\) by

        @@ -3487,7 +3487,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.error_functions.Shi(z)[source]
        +class sympy.functions.special.error_functions.Shi(z)[source]

        Sinh integral.

        Explanation

        This function is defined by

        @@ -3559,7 +3559,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.error_functions.Chi(z)[source]
        +class sympy.functions.special.error_functions.Chi(z)[source]

        Cosh integral.

        Explanation

        This function is defined for positive \(x\) by

        @@ -3645,7 +3645,7 @@

        Exponential, Logarithmic and Trigonometric Integrals

        Bessel Type Functions

        -class sympy.functions.special.bessel.BesselBase(nu, z)[source]
        +class sympy.functions.special.bessel.BesselBase(nu, z)[source]

        Abstract base class for Bessel-type functions.

        This class is meant to reduce code duplication. All Bessel-type functions can 1) be differentiated, with the derivatives @@ -3670,7 +3670,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.besselj(nu, z)[source]
        +class sympy.functions.special.bessel.besselj(nu, z)[source]

        Bessel function of the first kind.

        Explanation

        The Bessel \(J\) function of order \(\nu\) is defined to be the function @@ -3745,7 +3745,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.bessely(nu, z)[source]
        +class sympy.functions.special.bessel.bessely(nu, z)[source]

        Bessel function of the second kind.

        Explanation

        The Bessel \(Y\) function of order \(\nu\) is defined as

        @@ -3782,7 +3782,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.besseli(nu, z)[source]
        +class sympy.functions.special.bessel.besseli(nu, z)[source]

        Modified Bessel function of the first kind.

        Explanation

        The Bessel \(I\) function is a solution to the modified Bessel equation

        @@ -3819,7 +3819,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.besselk(nu, z)[source]
        +class sympy.functions.special.bessel.besselk(nu, z)[source]

        Modified Bessel function of the second kind.

        Explanation

        The Bessel \(K\) function of order \(\nu\) is defined as

        @@ -3853,7 +3853,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.hankel1(nu, z)[source]
        +class sympy.functions.special.bessel.hankel1(nu, z)[source]

        Hankel function of the first kind.

        Explanation

        This function is defined as

        @@ -3886,7 +3886,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.hankel2(nu, z)[source]
        +class sympy.functions.special.bessel.hankel2(nu, z)[source]

        Hankel function of the second kind.

        Explanation

        This function is defined as

        @@ -3920,7 +3920,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.jn(nu, z)[source]
        +class sympy.functions.special.bessel.jn(nu, z)[source]

        Spherical Bessel function of the first kind.

        Explanation

        This function is a solution to the spherical Bessel equation

        @@ -3976,7 +3976,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.yn(nu, z)[source]
        +class sympy.functions.special.bessel.yn(nu, z)[source]

        Spherical Bessel function of the second kind.

        Explanation

        This function is another solution to the spherical Bessel equation, and @@ -4022,7 +4022,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -sympy.functions.special.bessel.jn_zeros(n, k, method='sympy', dps=15)[source]
        +sympy.functions.special.bessel.jn_zeros(n, k, method='sympy', dps=15)[source]

        Zeros of the spherical Bessel function of the first kind.

        Parameters:
        @@ -4065,7 +4065,7 @@

        Exponential, Logarithmic and Trigonometric Integrals
        -class sympy.functions.special.bessel.marcumq(m, a, b)[source]
        +class sympy.functions.special.bessel.marcumq(m, a, b)[source]

        The Marcum Q-function.

        Explanation

        The Marcum Q-function is defined by the meromorphic continuation of

        @@ -4119,14 +4119,14 @@

        Exponential, Logarithmic and Trigonometric IntegralsAiry Functions

        -class sympy.functions.special.bessel.AiryBase(*args)[source]
        +class sympy.functions.special.bessel.AiryBase(*args)[source]

        Abstract base class for Airy functions.

        This class is meant to reduce code duplication.

        -class sympy.functions.special.bessel.airyai(arg)[source]
        +class sympy.functions.special.bessel.airyai(arg)[source]

        The Airy function \(\operatorname{Ai}\) of the first kind.

        Explanation

        The Airy function \(\operatorname{Ai}(z)\) is defined to be the function @@ -4227,7 +4227,7 @@

        Airy Functions
        -class sympy.functions.special.bessel.airybi(arg)[source]
        +class sympy.functions.special.bessel.airybi(arg)[source]

        The Airy function \(\operatorname{Bi}\) of the second kind.

        Explanation

        The Airy function \(\operatorname{Bi}(z)\) is defined to be the function @@ -4330,7 +4330,7 @@

        Airy Functions
        -class sympy.functions.special.bessel.airyaiprime(arg)[source]
        +class sympy.functions.special.bessel.airyaiprime(arg)[source]

        The derivative \(\operatorname{Ai}^\prime\) of the Airy function of the first kind.

        Explanation

        @@ -4424,7 +4424,7 @@

        Airy Functions
        -class sympy.functions.special.bessel.airybiprime(arg)[source]
        +class sympy.functions.special.bessel.airybiprime(arg)[source]

        The derivative \(\operatorname{Bi}^\prime\) of the Airy function of the first kind.

        Explanation

        @@ -4603,7 +4603,7 @@

        B-Splines
        -sympy.functions.special.bsplines.bspline_basis_set(d, knots, x)[source]
        +sympy.functions.special.bsplines.bspline_basis_set(d, knots, x)[source]

        Return the len(knots)-d-1 B-splines at x of degree d with knots.

        @@ -4649,7 +4649,7 @@

        B-Splines
        -sympy.functions.special.bsplines.interpolating_spline(d, x, X, Y)[source]
        +sympy.functions.special.bsplines.interpolating_spline(d, x, X, Y)[source]

        Return spline of degree d, passing through the given X and Y values.

        @@ -4697,7 +4697,7 @@

        B-Splines

        Riemann Zeta and Related Functions

        -class sympy.functions.special.zeta_functions.zeta(s, a=None)[source]
        +class sympy.functions.special.zeta_functions.zeta(s, a=None)[source]

        Hurwitz zeta function (or Riemann zeta function).

        Explanation

        For \(\operatorname{Re}(a) > 0\) and \(\operatorname{Re}(s) > 1\), this @@ -4809,7 +4809,7 @@

        B-Splines
        -class sympy.functions.special.zeta_functions.dirichlet_eta(s, a=None)[source]
        +class sympy.functions.special.zeta_functions.dirichlet_eta(s, a=None)[source]

        Dirichlet eta function.

        Explanation

        For \(\operatorname{Re}(s) > 0\) and \(0 < x \le 1\), this function is defined as

        @@ -4858,7 +4858,7 @@

        B-Splines
        -class sympy.functions.special.zeta_functions.polylog(s, z)[source]
        +class sympy.functions.special.zeta_functions.polylog(s, z)[source]

        Polylogarithm function.

        Explanation

        For \(|z| < 1\) and \(s \in \mathbb{C}\), the polylogarithm is @@ -4925,7 +4925,7 @@

        B-Splines
        -class sympy.functions.special.zeta_functions.lerchphi(*args)[source]
        +class sympy.functions.special.zeta_functions.lerchphi(*args)[source]

        Lerch transcendent (Lerch phi function).

        Explanation

        For \(\operatorname{Re}(a) > 0\), \(|z| < 1\) and \(s \in \mathbb{C}\), the @@ -5034,7 +5034,7 @@

        B-Splines
        -class sympy.functions.special.zeta_functions.stieltjes(n, a=None)[source]
        +class sympy.functions.special.zeta_functions.stieltjes(n, a=None)[source]

        Represents Stieltjes constants, \(\gamma_{k}\) that occur in Laurent Series expansion of the Riemann zeta function.

        Examples

        @@ -5075,7 +5075,7 @@

        B-Splines

        -class sympy.functions.special.hyper.hyper(ap, bq, z)[source]
        +class sympy.functions.special.hyper.hyper(ap, bq, z)[source]

        The generalized hypergeometric function is defined by a series where the ratios of successive terms are a rational function of the summation index. When convergent, it is continued analytically to the largest @@ -5239,7 +5239,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.hyper.meijerg(*args)[source]
        +class sympy.functions.special.hyper.meijerg(*args)[source]

        The Meijer G-function is defined by a Mellin-Barnes type integral that resembles an inverse Mellin transform. It generalizes the hypergeometric functions.

        @@ -5410,7 +5410,7 @@

        Hypergeometric Functions
        -get_period()[source]
        +get_period()[source]

        Return a number \(P\) such that \(G(x*exp(I*P)) == G(x)\).

        Examples

        >>> from sympy import meijerg, pi, S
        @@ -5431,7 +5431,7 @@ 

        Hypergeometric Functions
        -integrand(s)[source]
        +integrand(s)[source]

        Get the defining integrand D(s).

        @@ -5452,7 +5452,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.hyper.appellf1(a, b1, b2, c, x, y)[source]
        +class sympy.functions.special.hyper.appellf1(a, b1, b2, c, x, y)[source]

        This is the Appell hypergeometric function of two variables as:

        @@ -5495,7 +5495,7 @@

        Hypergeometric Functions

        Elliptic integrals

        -class sympy.functions.special.elliptic_integrals.elliptic_k(m)[source]
        +class sympy.functions.special.elliptic_integrals.elliptic_k(m)[source]

        The complete elliptic integral of the first kind, defined by

        @@ -5540,7 +5540,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.elliptic_integrals.elliptic_f(z, m)[source]
        +class sympy.functions.special.elliptic_integrals.elliptic_f(z, m)[source]

        The Legendre incomplete elliptic integral of the first kind, defined by

        @@ -5583,7 +5583,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.elliptic_integrals.elliptic_e(m, z=None)[source]
        +class sympy.functions.special.elliptic_integrals.elliptic_e(m, z=None)[source]

        Called with two arguments \(z\) and \(m\), evaluates the incomplete elliptic integral of the second kind, defined by

        @@ -5637,7 +5637,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.elliptic_integrals.elliptic_pi(n, m, z=None)[source]
        +class sympy.functions.special.elliptic_integrals.elliptic_pi(n, m, z=None)[source]

        Called with three arguments \(n\), \(z\) and \(m\), evaluates the Legendre incomplete elliptic integral of the third kind, defined by

        @@ -5692,14 +5692,14 @@

        Hypergeometric Functions

        Mathieu Functions

        -class sympy.functions.special.mathieu_functions.MathieuBase(*args)[source]
        +class sympy.functions.special.mathieu_functions.MathieuBase(*args)[source]

        Abstract base class for Mathieu functions.

        This class is meant to reduce code duplication.

        -class sympy.functions.special.mathieu_functions.mathieus(a, q, z)[source]
        +class sympy.functions.special.mathieu_functions.mathieus(a, q, z)[source]

        The Mathieu Sine function \(S(a,q,z)\).

        Explanation

        This function is one solution of the Mathieu differential equation:

        @@ -5759,7 +5759,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.mathieu_functions.mathieuc(a, q, z)[source]
        +class sympy.functions.special.mathieu_functions.mathieuc(a, q, z)[source]

        The Mathieu Cosine function \(C(a,q,z)\).

        Explanation

        This function is one solution of the Mathieu differential equation:

        @@ -5819,7 +5819,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.mathieu_functions.mathieusprime(a, q, z)[source]
        +class sympy.functions.special.mathieu_functions.mathieusprime(a, q, z)[source]

        The derivative \(S^{\prime}(a,q,z)\) of the Mathieu Sine function.

        Explanation

        This function is one solution of the Mathieu differential equation:

        @@ -5879,7 +5879,7 @@

        Hypergeometric Functions
        -class sympy.functions.special.mathieu_functions.mathieucprime(a, q, z)[source]
        +class sympy.functions.special.mathieu_functions.mathieucprime(a, q, z)[source]

        The derivative \(C^{\prime}(a,q,z)\) of the Mathieu Cosine function.

        Explanation

        This function is one solution of the Mathieu differential equation:

        @@ -5947,7 +5947,7 @@

        Hypergeometric Functions

        -class sympy.functions.special.polynomials.jacobi(n, a, b, x)[source]
        +class sympy.functions.special.polynomials.jacobi(n, a, b, x)[source]

        Jacobi polynomial \(P_n^{\left(\alpha, \beta\right)}(x)\).

        Explanation

        jacobi(n, alpha, beta, x) gives the \(n\)th Jacobi polynomial @@ -6029,7 +6029,7 @@

        Jacobi Polynomials
        -sympy.functions.special.polynomials.jacobi_normalized(n, a, b, x)[source]
        +sympy.functions.special.polynomials.jacobi_normalized(n, a, b, x)[source]

        Jacobi polynomial \(P_n^{\left(\alpha, \beta\right)}(x)\).

        Parameters:
        @@ -6088,7 +6088,7 @@

        Jacobi Polynomials

        -class sympy.functions.special.polynomials.gegenbauer(n, a, x)[source]
        +class sympy.functions.special.polynomials.gegenbauer(n, a, x)[source]

        Gegenbauer polynomial \(C_n^{\left(\alpha\right)}(x)\).

        Explanation

        gegenbauer(n, alpha, x) gives the \(n\)th Gegenbauer polynomial @@ -6154,7 +6154,7 @@

        Gegenbauer PolynomialsChebyshev Polynomials

        -class sympy.functions.special.polynomials.chebyshevt(n, x)[source]
        +class sympy.functions.special.polynomials.chebyshevt(n, x)[source]

        Chebyshev polynomial of the first kind, \(T_n(x)\).

        Explanation

        chebyshevt(n, x) gives the \(n\)th Chebyshev polynomial (of the first @@ -6221,7 +6221,7 @@

        Chebyshev Polynomials
        -class sympy.functions.special.polynomials.chebyshevu(n, x)[source]
        +class sympy.functions.special.polynomials.chebyshevu(n, x)[source]

        Chebyshev polynomial of the second kind, \(U_n(x)\).

        Explanation

        chebyshevu(n, x) gives the \(n\)th Chebyshev polynomial of the second @@ -6288,7 +6288,7 @@

        Chebyshev Polynomials
        -class sympy.functions.special.polynomials.chebyshevt_root(n, k)[source]
        +class sympy.functions.special.polynomials.chebyshevt_root(n, k)[source]

        chebyshev_root(n, k) returns the \(k\)th root (indexed from zero) of the \(n\)th Chebyshev polynomial of the first kind; that is, if \(0 \le k < n\), chebyshevt(n, chebyshevt_root(n, k)) == 0.

        @@ -6308,7 +6308,7 @@

        Chebyshev Polynomials
        -class sympy.functions.special.polynomials.chebyshevu_root(n, k)[source]
        +class sympy.functions.special.polynomials.chebyshevu_root(n, k)[source]

        chebyshevu_root(n, k) returns the \(k\)th root (indexed from zero) of the \(n\)th Chebyshev polynomial of the second kind; that is, if \(0 \le k < n\), chebyshevu(n, chebyshevu_root(n, k)) == 0.

        @@ -6331,7 +6331,7 @@

        Chebyshev PolynomialsLegendre Polynomials

        -class sympy.functions.special.polynomials.legendre(n, x)[source]
        +class sympy.functions.special.polynomials.legendre(n, x)[source]

        legendre(n, x) gives the \(n\)th Legendre polynomial of \(x\), \(P_n(x)\)

        Explanation

        The Legendre polynomials are orthogonal on \([-1, 1]\) with respect to @@ -6379,7 +6379,7 @@

        Legendre Polynomials
        -class sympy.functions.special.polynomials.assoc_legendre(n, m, x)[source]
        +class sympy.functions.special.polynomials.assoc_legendre(n, m, x)[source]

        assoc_legendre(n, m, x) gives \(P_n^m(x)\), where \(n\) and \(m\) are the degree and order or an expression which is related to the nth order Legendre polynomial, \(P_n(x)\) in the following manner:

        @@ -6437,7 +6437,7 @@

        Legendre PolynomialsHermite Polynomials

        -class sympy.functions.special.polynomials.hermite(n, x)[source]
        +class sympy.functions.special.polynomials.hermite(n, x)[source]

        hermite(n, x) gives the \(n\)th Hermite polynomial in \(x\), \(H_n(x)\).

        Explanation

        The Hermite polynomials are orthogonal on \((-\infty, \infty)\) @@ -6482,7 +6482,7 @@

        Hermite Polynomials
        -class sympy.functions.special.polynomials.hermite_prob(n, x)[source]
        +class sympy.functions.special.polynomials.hermite_prob(n, x)[source]

        hermite_prob(n, x) gives the \(n\)th probabilist’s Hermite polynomial in \(x\), \(He_n(x)\).

        Explanation

        @@ -6534,7 +6534,7 @@

        Hermite Polynomials

        -class sympy.functions.special.polynomials.laguerre(n, x)[source]
        +class sympy.functions.special.polynomials.laguerre(n, x)[source]

        Returns the \(n\)th Laguerre polynomial in \(x\), \(L_n(x)\).

        Parameters:
        @@ -6592,7 +6592,7 @@

        Laguerre Polynomials
        -class sympy.functions.special.polynomials.assoc_laguerre(n, alpha, x)[source]
        +class sympy.functions.special.polynomials.assoc_laguerre(n, alpha, x)[source]

        Returns the \(n\)th generalized Laguerre polynomial in \(x\), \(L_n(x)\).

        Parameters:
        @@ -6672,7 +6672,7 @@

        Laguerre PolynomialsSpherical Harmonics

        -class sympy.functions.special.spherical_harmonics.Ynm(n, m, theta, phi)[source]
        +class sympy.functions.special.spherical_harmonics.Ynm(n, m, theta, phi)[source]

        Spherical harmonics defined as

        @@ -6815,7 +6815,7 @@

        Spherical Harmonics
        -sympy.functions.special.spherical_harmonics.Ynm_c(n, m, theta, phi)[source]
        +sympy.functions.special.spherical_harmonics.Ynm_c(n, m, theta, phi)[source]

        Conjugate spherical harmonics defined as

        @@ -6863,7 +6863,7 @@

        Spherical Harmonics
        -class sympy.functions.special.spherical_harmonics.Znm(n, m, theta, phi)[source]
        +class sympy.functions.special.spherical_harmonics.Znm(n, m, theta, phi)[source]

        Real spherical harmonics defined as

        @@ -6929,7 +6929,7 @@

        Spherical Harmonics

        -sympy.functions.special.tensor_functions.Eijk(*args, **kwargs)[source]
        +sympy.functions.special.tensor_functions.Eijk(*args, **kwargs)[source]

        Represent the Levi-Civita symbol.

        This is a compatibility wrapper to LeviCivita().

        @@ -6940,13 +6940,13 @@

        Tensor Functions
        -sympy.functions.special.tensor_functions.eval_levicivita(*args)[source]
        +sympy.functions.special.tensor_functions.eval_levicivita(*args)[source]

        Evaluate Levi-Civita symbol.

        -class sympy.functions.special.tensor_functions.LeviCivita(*args)[source]
        +class sympy.functions.special.tensor_functions.LeviCivita(*args)[source]

        Represent the Levi-Civita symbol.

        Explanation

        For even permutations of indices it returns 1, for odd permutations -1, and @@ -6975,7 +6975,7 @@

        Tensor Functions
        -class sympy.functions.special.tensor_functions.KroneckerDelta(i, j, delta_range=None)[source]
        +class sympy.functions.special.tensor_functions.KroneckerDelta(i, j, delta_range=None)[source]

        The discrete, or Kronecker, delta function.

        Parameters:
        @@ -7026,7 +7026,7 @@

        Tensor Functions
        -classmethod eval(i, j, delta_range=None)[source]
        +classmethod eval(i, j, delta_range=None)[source]

        Evaluates the discrete delta function.

        Examples

        >>> from sympy import KroneckerDelta
        diff --git a/dev/modules/geometry/curves.html b/dev/modules/geometry/curves.html
        index 142a04712b3..7edc6f4eb71 100644
        --- a/dev/modules/geometry/curves.html
        +++ b/dev/modules/geometry/curves.html
        @@ -805,7 +805,7 @@ 
        Documentation Version

        Curves

        -class sympy.geometry.curve.Curve(function, limits)[source]
        +class sympy.geometry.curve.Curve(function, limits)[source]

        A curve in space.

        A curve is defined by parametric functions for the coordinates, a parameter and the lower and upper bounds for the parameter value.

        @@ -887,7 +887,7 @@
        Documentation Version
        -arbitrary_point(parameter='t')[source]
        +arbitrary_point(parameter='t')[source]

        A parameterized point on the curve.

        Parameters:
        @@ -1048,7 +1048,7 @@
        Documentation Version
        -plot_interval(parameter='t')[source]
        +plot_interval(parameter='t')[source]

        The plot interval for the default geometric plot of the curve.

        Parameters:
        @@ -1088,7 +1088,7 @@
        Documentation Version
        -rotate(angle=0, pt=None)[source]
        +rotate(angle=0, pt=None)[source]

        This function is used to rotate a curve along given point pt at given angle(in radian).

        Parameters:
        @@ -1121,7 +1121,7 @@
        Documentation Version
        -scale(x=1, y=1, pt=None)[source]
        +scale(x=1, y=1, pt=None)[source]

        Override GeometryEntity.scale since Curve is not made up of Points.

        Returns:
        @@ -1142,7 +1142,7 @@
        Documentation Version
        -translate(x=0, y=0)[source]
        +translate(x=0, y=0)[source]

        Translate the Curve by (x, y).

        Returns:
        diff --git a/dev/modules/geometry/ellipses.html b/dev/modules/geometry/ellipses.html index 97fb7de1df6..bea44659f5b 100644 --- a/dev/modules/geometry/ellipses.html +++ b/dev/modules/geometry/ellipses.html @@ -815,7 +815,7 @@
        Documentation Version
        **kwargs,
        -)[source] +)[source]

        An elliptical GeometryEntity.

        Parameters:
        @@ -931,7 +931,7 @@
        Documentation Version
        -arbitrary_point(parameter='t')[source]
        +arbitrary_point(parameter='t')[source]

        A parameterized point on the ellipse.

        Parameters:
        @@ -984,7 +984,7 @@
        Documentation Version
        -auxiliary_circle()[source]
        +auxiliary_circle()[source]

        Returns a Circle whose diameter is the major axis of the ellipse.

        Examples

        >>> from sympy import Ellipse, Point, symbols
        @@ -1044,7 +1044,7 @@ 
        Documentation Version
        -director_circle()[source]
        +director_circle()[source]

        Returns a Circle consisting of all points where two perpendicular tangent lines to the ellipse cross each other.

        @@ -1095,7 +1095,7 @@
        Documentation Version
        -encloses_point(p)[source]
        +encloses_point(p)[source]

        Return True if p is enclosed by (is inside of) self.

        Parameters:
        @@ -1127,7 +1127,7 @@
        Documentation Version
        -equation(x='x', y='y', _slope=None)[source]
        +equation(x='x', y='y', _slope=None)[source]

        Returns the equation of an ellipse aligned with the x and y axes; when slope is given, the equation returned corresponds to an ellipse with a major axis having that slope.

        @@ -1194,7 +1194,7 @@
        Documentation Version
        -evolute(x='x', y='y')[source]
        +evolute(x='x', y='y')[source]

        The equation of evolute of the ellipse.

        Parameters:
        @@ -1301,7 +1301,7 @@
        Documentation Version
        -intersection(o)[source]
        +intersection(o)[source]

        The intersection of this ellipse and another geometrical entity \(o\).

        @@ -1349,7 +1349,7 @@
        Documentation Version
        -is_tangent(o)[source]
        +is_tangent(o)[source]

        Is \(o\) tangent to the ellipse?

        Parameters:
        @@ -1462,7 +1462,7 @@
        Documentation Version
        -normal_lines(p, prec=None)[source]
        +normal_lines(p, prec=None)[source]

        Normal lines between \(p\) and the ellipse.

        Parameters:
        @@ -1524,7 +1524,7 @@
        Documentation Version
        -plot_interval(parameter='t')[source]
        +plot_interval(parameter='t')[source]

        The plot interval for the default geometric plot of the Ellipse.

        Parameters:
        @@ -1551,7 +1551,7 @@
        Documentation Version
        -polar_second_moment_of_area()[source]
        +polar_second_moment_of_area()[source]

        Returns the polar second moment of area of an Ellipse

        It is a constituent of the second moment of area, linked through the perpendicular axis theorem. While the planar second moment of @@ -1583,7 +1583,7 @@

        Documentation Version
        -random_point(seed=None)[source]
        +random_point(seed=None)[source]

        A random point on the ellipse.

        Returns:
        @@ -1628,7 +1628,7 @@
        Documentation Version
        -reflect(line)[source]
        +reflect(line)[source]

        Override GeometryEntity.reflect since the radius is not a GeometryEntity.

        Examples

        @@ -1653,7 +1653,7 @@
        Documentation Version
        -rotate(angle=0, pt=None)[source]
        +rotate(angle=0, pt=None)[source]

        Rotate angle radians counterclockwise about Point pt.

        Note: since the general ellipse is not supported, only rotations that are integer multiples of pi/2 are allowed.

        @@ -1669,7 +1669,7 @@
        Documentation Version
        -scale(x=1, y=1, pt=None)[source]
        +scale(x=1, y=1, pt=None)[source]

        Override GeometryEntity.scale since it is the major and minor axes which must be scaled and they are not GeometryEntities.

        Examples

        @@ -1684,7 +1684,7 @@
        Documentation Version
        -second_moment_of_area(point=None)[source]
        +second_moment_of_area(point=None)[source]

        Returns the second moment and product moment area of an ellipse.

        Parameters:
        @@ -1722,7 +1722,7 @@
        Documentation Version
        -section_modulus(point=None)[source]
        +section_modulus(point=None)[source]

        Returns a tuple with the section modulus of an ellipse

        Section modulus is a geometric property of an ellipse defined as the ratio of second moment of area to the distance of the extreme end of @@ -1811,7 +1811,7 @@

        Documentation Version
        -tangent_lines(p)[source]
        +tangent_lines(p)[source]

        Tangent lines between \(p\) and the ellipse.

        If \(p\) is on the ellipse, returns the tangent line through point \(p\). Otherwise, returns the tangent line(s) from \(p\) to the ellipse, or @@ -1870,7 +1870,7 @@

        Documentation Version
        -class sympy.geometry.ellipse.Circle(*args, **kwargs)[source]
        +class sympy.geometry.ellipse.Circle(*args, **kwargs)[source]

        A circle in space.

        Constructed simply from a center and a radius, from three non-collinear points, or the equation of a circle.

        @@ -1958,7 +1958,7 @@
        Documentation Version
        -equation(x='x', y='y')[source]
        +equation(x='x', y='y')[source]

        The equation of the circle.

        Parameters:
        @@ -1986,7 +1986,7 @@
        Documentation Version
        -intersection(o)[source]
        +intersection(o)[source]

        The intersection of this circle with another geometrical entity.

        Parameters:
        @@ -2037,7 +2037,7 @@
        Documentation Version
        -reflect(line)[source]
        +reflect(line)[source]

        Override GeometryEntity.reflect since the radius is not a GeometryEntity.

        Examples

        @@ -2050,7 +2050,7 @@
        Documentation Version
        -scale(x=1, y=1, pt=None)[source]
        +scale(x=1, y=1, pt=None)[source]

        Override GeometryEntity.scale since the radius is not a GeometryEntity.

        Examples

        diff --git a/dev/modules/geometry/entities.html b/dev/modules/geometry/entities.html index fb26d8eaa85..e39d32dd418 100644 --- a/dev/modules/geometry/entities.html +++ b/dev/modules/geometry/entities.html @@ -805,7 +805,7 @@
        Documentation Version

        Entities

        -class sympy.geometry.entity.GeometryEntity(*args, **kwargs)[source]
        +class sympy.geometry.entity.GeometryEntity(*args, **kwargs)[source]

        The base class for all geometrical entities.

        This class does not represent any particular geometric entity, it only provides the implementation of some methods common to all subclasses.

        @@ -824,7 +824,7 @@
        Documentation Version
        -encloses(o)[source]
        +encloses(o)[source]

        Return True if o is inside (not on or outside) the boundaries of self.

        The object will be decomposed into Points and individual Entities need only define an encloses_point method for their class.

        @@ -846,7 +846,7 @@
        Documentation Version
        -intersection(o)[source]
        +intersection(o)[source]

        Returns a list of all of the intersections of self with o.

        Notes

        An entity is not required to implement this method.

        @@ -861,7 +861,7 @@
        Documentation Version
        -is_similar(other)[source]
        +is_similar(other)[source]

        Is this geometrical entity similar to another geometrical entity?

        Two entities are similar if a uniform scaling (enlarging or shrinking) of one of the entities will allow one to obtain the other.

        @@ -879,7 +879,7 @@
        Documentation Version
        -parameter_value(other, t)[source]
        +parameter_value(other, t)[source]

        Return the parameter corresponding to the given point. Evaluating an arbitrary point of the entity at this parameter value will return the given point.

        @@ -898,7 +898,7 @@
        Documentation Version
        -reflect(line)[source]
        +reflect(line)[source]

        Reflects an object across a line.

        Parameters:
        @@ -926,7 +926,7 @@
        Documentation Version
        -rotate(angle, pt=None)[source]
        +rotate(angle, pt=None)[source]

        Rotate angle radians counterclockwise about Point pt.

        The default pt is the origin, Point(0, 0)

        Examples

        @@ -946,7 +946,7 @@
        Documentation Version
        -scale(x=1, y=1, pt=None)[source]
        +scale(x=1, y=1, pt=None)[source]

        Scale the object by multiplying the x,y-coordinates by x and y.

        If pt is given, the scaling is done relative to that point; the object is shifted by -pt, scaled, and shifted by pt.

        @@ -969,7 +969,7 @@
        Documentation Version
        -translate(x=0, y=0)[source]
        +translate(x=0, y=0)[source]

        Shift the object by adding to the x,y-coordinates the values x and y.

        Examples

        >>> from sympy import RegularPolygon, Point, Polygon
        diff --git a/dev/modules/geometry/lines.html b/dev/modules/geometry/lines.html
        index b0a8277b5b2..3bba0b460e5 100644
        --- a/dev/modules/geometry/lines.html
        +++ b/dev/modules/geometry/lines.html
        @@ -805,7 +805,7 @@ 
        Documentation Version

        Lines

        -class sympy.geometry.line.LinearEntity(p1, p2=None, **kwargs)[source]
        +class sympy.geometry.line.LinearEntity(p1, p2=None, **kwargs)[source]

        A base class for all linear entities (Line, Ray and Segment) in n-dimensional Euclidean space.

        Notes

        @@ -871,7 +871,7 @@
        Documentation Version
        -angle_between(l2)[source]
        +angle_between(l2)[source]

        Return the non-reflex angle formed by rays emanating from the origin with directions the same as the direction vectors of the linear entities.

        @@ -926,7 +926,7 @@
        Documentation Version
        -arbitrary_point(parameter='t')[source]
        +arbitrary_point(parameter='t')[source]

        A parameterized point on the Line.

        Parameters:
        @@ -969,7 +969,7 @@
        Documentation Version
        -static are_concurrent(*lines)[source]
        +static are_concurrent(*lines)[source]

        Is a sequence of linear entities concurrent?

        Two or more linear entities are concurrent if they all intersect at a single point.

        @@ -1014,7 +1014,7 @@
        Documentation Version
        -bisectors(other)[source]
        +bisectors(other)[source]

        Returns the perpendicular lines which pass through the intersections of self and other that are in the same plane.

        @@ -1037,7 +1037,7 @@
        Documentation Version
        -contains(other)[source]
        +contains(other)[source]

        Subclasses should implement this method and should return True if other is on the boundaries of self; False if not on the boundaries of self; @@ -1078,7 +1078,7 @@

        Documentation Version
        -intersection(other)[source]
        +intersection(other)[source]

        The intersection with another geometrical entity.

        Parameters:
        @@ -1125,7 +1125,7 @@
        Documentation Version
        -is_parallel(l2)[source]
        +is_parallel(l2)[source]

        Are two linear entities parallel?

        Parameters:
        @@ -1168,7 +1168,7 @@
        Documentation Version
        -is_perpendicular(l2)[source]
        +is_perpendicular(l2)[source]

        Are two linear entities perpendicular?

        Parameters:
        @@ -1209,7 +1209,7 @@
        Documentation Version
        -is_similar(other)[source]
        +is_similar(other)[source]

        Return True if self and other are contained in the same line.

        Examples

        >>> from sympy import Point, Line
        @@ -1274,7 +1274,7 @@ 
        Documentation Version
        -parallel_line(p)[source]
        +parallel_line(p)[source]

        Create a new Line parallel to this linear entity which passes through the point \(p\).

        @@ -1312,7 +1312,7 @@
        Documentation Version
        -perpendicular_line(p)[source]
        +perpendicular_line(p)[source]

        Create a new Line perpendicular to this linear entity which passes through the point \(p\).

        @@ -1348,7 +1348,7 @@
        Documentation Version
        -perpendicular_segment(p)[source]
        +perpendicular_segment(p)[source]

        Create a perpendicular line segment from \(p\) to this line.

        The endpoints of the segment are p and the closest point in the line containing self. (If self is not a line, the point might @@ -1417,7 +1417,7 @@

        Documentation Version
        -projection(other)[source]
        +projection(other)[source]

        Project a point, line, ray, or segment onto this linear entity.

        Parameters:
        @@ -1472,7 +1472,7 @@
        Documentation Version
        -random_point(seed=None)[source]
        +random_point(seed=None)[source]

        A random point on a LinearEntity.

        Returns:
        @@ -1502,7 +1502,7 @@
        Documentation Version
        -smallest_angle_between(l2)[source]
        +smallest_angle_between(l2)[source]

        Return the smallest angle formed at the intersection of the lines containing the linear entities.

        @@ -1532,7 +1532,7 @@
        Documentation Version
        -class sympy.geometry.line.Line(*args, **kwargs)[source]
        +class sympy.geometry.line.Line(*args, **kwargs)[source]

        An infinite line in space.

        A 2D line is declared with two distinct points, point and slope, or an equation. A 3D line may be defined with a point and a direction ratio.

        @@ -1597,7 +1597,7 @@
        Documentation Version
        -contains(other)[source]
        +contains(other)[source]

        Return True if \(other\) is on this Line, or False otherwise.

        Examples

        >>> from sympy import Line,Point
        @@ -1624,7 +1624,7 @@ 
        Documentation Version
        -distance(other)[source]
        +distance(other)[source]

        Finds the shortest distance between a line and a point.

        Raises:
        @@ -1651,13 +1651,13 @@
        Documentation Version
        -equals(other)[source]
        +equals(other)[source]

        Returns True if self and other are the same mathematical entities

        -plot_interval(parameter='t')[source]
        +plot_interval(parameter='t')[source]

        The plot interval for the default geometric plot of line. Gives values that will produce a line that is +/- 5 units long (where a unit is the distance between the two points that define the line).

        @@ -1689,7 +1689,7 @@
        Documentation Version
        -class sympy.geometry.line.Ray(p1, p2=None, **kwargs)[source]
        +class sympy.geometry.line.Ray(p1, p2=None, **kwargs)[source]

        A Ray is a semi-line in the space with a source point and a direction.

        Parameters:
        @@ -1743,7 +1743,7 @@
        Documentation Version
        -contains(other)[source]
        +contains(other)[source]

        Is other GeometryEntity contained in this Ray?

        Examples

        >>> from sympy import Ray,Point,Segment
        @@ -1773,7 +1773,7 @@ 
        Documentation Version
        -distance(other)[source]
        +distance(other)[source]

        Finds the shortest distance between the ray and a point.

        Raises:
        @@ -1802,13 +1802,13 @@
        Documentation Version
        -equals(other)[source]
        +equals(other)[source]

        Returns True if self and other are the same mathematical entities

        -plot_interval(parameter='t')[source]
        +plot_interval(parameter='t')[source]

        The plot interval for the default geometric plot of the Ray. Gives values that will produce a ray that is 10 units long (where a unit is the distance between the two points that define the ray).

        @@ -1861,7 +1861,7 @@
        Documentation Version
        -class sympy.geometry.line.Segment(p1, p2, **kwargs)[source]
        +class sympy.geometry.line.Segment(p1, p2, **kwargs)[source]

        A line segment in space.

        Parameters:
        @@ -1916,7 +1916,7 @@
        Documentation Version
        -contains(other)[source]
        +contains(other)[source]

        Is the other GeometryEntity contained within this Segment?

        Examples

        >>> from sympy import Point, Segment
        @@ -1939,7 +1939,7 @@ 
        Documentation Version
        -distance(other)[source]
        +distance(other)[source]

        Finds the shortest distance between a line segment and a point.

        Raises:
        @@ -1967,7 +1967,7 @@
        Documentation Version
        -equals(other)[source]
        +equals(other)[source]

        Returns True if self and other are the same mathematical entities

        @@ -2019,7 +2019,7 @@
        Documentation Version
        -perpendicular_bisector(p=None)[source]
        +perpendicular_bisector(p=None)[source]

        The perpendicular bisector of this segment.

        If no point is specified or the point specified is not on the bisector then the bisector is returned as a Line. Otherwise a @@ -2053,7 +2053,7 @@

        Documentation Version
        -plot_interval(parameter='t')[source]
        +plot_interval(parameter='t')[source]

        The plot interval for the default geometric plot of the Segment gives values that will produce the full segment in a plot.

        @@ -2084,7 +2084,7 @@
        Documentation Version
        -class sympy.geometry.line.LinearEntity2D(p1, p2=None, **kwargs)[source]
        +class sympy.geometry.line.LinearEntity2D(p1, p2=None, **kwargs)[source]

        A base class for all linear entities (line, ray and segment) in a 2-dimensional Euclidean space.

        Notes

        @@ -2124,7 +2124,7 @@
        Documentation Version
        -perpendicular_line(p)[source]
        +perpendicular_line(p)[source]

        Create a new Line perpendicular to this linear entity which passes through the point \(p\).

        @@ -2193,7 +2193,7 @@
        Documentation Version
        -class sympy.geometry.line.Line2D(p1, pt=None, slope=None, **kwargs)[source]
        +class sympy.geometry.line.Line2D(p1, pt=None, slope=None, **kwargs)[source]

        An infinite line in space 2D.

        A line is declared with two distinct points or a point and slope as defined using keyword \(slope\).

        @@ -2259,7 +2259,7 @@
        Documentation Version
        -equation(x='x', y='y')[source]
        +equation(x='x', y='y')[source]

        The equation of the line: ax + by + c.

        Parameters:
        @@ -2294,7 +2294,7 @@
        Documentation Version
        -class sympy.geometry.line.Ray2D(p1, pt=None, angle=None, **kwargs)[source]
        +class sympy.geometry.line.Ray2D(p1, pt=None, angle=None, **kwargs)[source]

        A Ray is a semi-line in the space with a source point and a direction.

        Parameters:
        @@ -2351,7 +2351,7 @@
        Documentation Version
        -closing_angle(r2)[source]
        +closing_angle(r2)[source]

        Return the angle by which r2 must be rotated so it faces the same direction as r1.

        @@ -2431,7 +2431,7 @@
        Documentation Version
        -class sympy.geometry.line.Segment2D(p1, p2, **kwargs)[source]
        +class sympy.geometry.line.Segment2D(p1, p2, **kwargs)[source]

        A line segment in 2D space.

        Parameters:
        @@ -2476,7 +2476,7 @@
        Documentation Version
        -class sympy.geometry.line.LinearEntity3D(p1, p2, **kwargs)[source]
        +class sympy.geometry.line.LinearEntity3D(p1, p2, **kwargs)[source]

        An base class for all linear entities (line, ray and segment) in a 3-dimensional Euclidean space.

        Notes

        @@ -2545,7 +2545,7 @@
        Documentation Version
        -class sympy.geometry.line.Line3D(p1, pt=None, direction_ratio=(), **kwargs)[source]
        +class sympy.geometry.line.Line3D(p1, pt=None, direction_ratio=(), **kwargs)[source]

        An infinite 3D line in space.

        A line is declared with two distinct points or a point and direction_ratio as defined using keyword \(direction_ratio\).

        @@ -2571,7 +2571,7 @@
        Documentation Version
        -distance(other)[source]
        +distance(other)[source]

        Finds the shortest distance between a line and another object.

        Parameters:
        @@ -2607,7 +2607,7 @@
        Documentation Version
        -equation(x='x', y='y', z='z')[source]
        +equation(x='x', y='y', z='z')[source]

        Return the equations that define the line in 3D.

        Parameters:
        @@ -2645,7 +2645,7 @@
        Documentation Version
        -class sympy.geometry.line.Ray3D(p1, pt=None, direction_ratio=(), **kwargs)[source]
        +class sympy.geometry.line.Ray3D(p1, pt=None, direction_ratio=(), **kwargs)[source]

        A Ray is a semi-line in the space with a source point and a direction.

        Parameters:
        @@ -2772,7 +2772,7 @@
        Documentation Version
        -class sympy.geometry.line.Segment3D(p1, p2, **kwargs)[source]
        +class sympy.geometry.line.Segment3D(p1, p2, **kwargs)[source]

        A line segment in a 3D space.

        Parameters:
        diff --git a/dev/modules/geometry/plane.html b/dev/modules/geometry/plane.html index 3ad89ee3d88..ce7ea6a3b12 100644 --- a/dev/modules/geometry/plane.html +++ b/dev/modules/geometry/plane.html @@ -805,7 +805,7 @@
        Documentation Version

        Plane

        -class sympy.geometry.plane.Plane(p1, a=None, b=None, **kwargs)[source]
        +class sympy.geometry.plane.Plane(p1, a=None, b=None, **kwargs)[source]

        A plane is a flat, two-dimensional surface. A plane is the two-dimensional analogue of a point (zero-dimensions), a line (one-dimension) and a solid (three-dimensions). A plane can generally be constructed by two types of @@ -837,7 +837,7 @@

        Documentation Version
        -angle_between(o)[source]
        +angle_between(o)[source]

        Angle between the plane and other geometric entity.

        Parameters:
        @@ -864,7 +864,7 @@
        Documentation Version
        -arbitrary_point(u=None, v=None)[source]
        +arbitrary_point(u=None, v=None)[source]

        Returns an arbitrary point on the Plane. If given two parameters, the point ranges over the entire plane. If given 1 or no parameters, returns a point with one parameter which, @@ -897,7 +897,7 @@

        Documentation Version
        -static are_concurrent(*planes)[source]
        +static are_concurrent(*planes)[source]

        Is a sequence of Planes concurrent?

        Two or more Planes are concurrent if their intersections are a common line.

        @@ -924,7 +924,7 @@
        Documentation Version
        -distance(o)[source]
        +distance(o)[source]

        Distance between the plane and another geometric entity.

        Parameters:
        @@ -954,7 +954,7 @@
        Documentation Version
        -equals(o)[source]
        +equals(o)[source]

        Returns True if self and o are the same mathematical entities.

        Examples

        >>> from sympy import Plane, Point3D
        @@ -973,7 +973,7 @@ 
        Documentation Version
        -equation(x=None, y=None, z=None)[source]
        +equation(x=None, y=None, z=None)[source]

        The equation of the Plane.

        Examples

        >>> from sympy import Point3D, Plane
        @@ -989,7 +989,7 @@ 
        Documentation Version
        -intersection(o)[source]
        +intersection(o)[source]

        The intersection with other geometrical entity.

        Parameters:
        @@ -1018,7 +1018,7 @@
        Documentation Version
        -is_coplanar(o)[source]
        +is_coplanar(o)[source]

        Returns True if \(o\) is coplanar with self, else False.

        Examples

        >>> from sympy import Plane
        @@ -1035,7 +1035,7 @@ 
        Documentation Version
        -is_parallel(l)[source]
        +is_parallel(l)[source]

        Is the given geometric entity parallel to the plane?

        Parameters:
        @@ -1057,7 +1057,7 @@
        Documentation Version
        -is_perpendicular(l)[source]
        +is_perpendicular(l)[source]

        Is the given geometric entity perpendicualar to the given plane?

        Parameters:
        @@ -1113,7 +1113,7 @@
        Documentation Version
        -parallel_plane(pt)[source]
        +parallel_plane(pt)[source]

        Plane parallel to the given plane and passing through the point pt.

        Parameters:
        @@ -1134,7 +1134,7 @@
        Documentation Version
        -parameter_value(other, u, v=None)[source]
        +parameter_value(other, u, v=None)[source]

        Return the parameter(s) corresponding to the given point.

        Examples

        >>> from sympy import pi, Plane
        @@ -1174,7 +1174,7 @@ 
        Documentation Version
        -perpendicular_line(pt)[source]
        +perpendicular_line(pt)[source]

        A line perpendicular to the given plane.

        Parameters:
        @@ -1195,7 +1195,7 @@
        Documentation Version
        -perpendicular_plane(*pts)[source]
        +perpendicular_plane(*pts)[source]

        Return a perpendicular passing through the given points. If the direction ratio between the points is the same as the Plane’s normal vector then, to select from the infinite number of possible planes, @@ -1227,7 +1227,7 @@

        Documentation Version
        -projection(pt)[source]
        +projection(pt)[source]

        Project the given point onto the plane along the plane normal.

        Parameters:
        @@ -1261,7 +1261,7 @@
        Documentation Version
        -projection_line(line)[source]
        +projection_line(line)[source]

        Project the given line onto the plane through the normal plane containing the line.

        @@ -1293,7 +1293,7 @@
        Documentation Version
        -random_point(seed=None)[source]
        +random_point(seed=None)[source]

        Returns a random point on the Plane.

        Returns:
        diff --git a/dev/modules/geometry/points.html b/dev/modules/geometry/points.html index f660cff49db..0c8482e66bc 100644 --- a/dev/modules/geometry/points.html +++ b/dev/modules/geometry/points.html @@ -805,7 +805,7 @@
        Documentation Version

        Points

        -class sympy.geometry.point.Point(*args, **kwargs)[source]
        +class sympy.geometry.point.Point(*args, **kwargs)[source]

        A point in a n-dimensional Euclidean space.

        Parameters:
        @@ -883,7 +883,7 @@
        Documentation Version
        -static affine_rank(*args)[source]
        +static affine_rank(*args)[source]

        The affine rank of a set of points is the dimension of the smallest affine space containing all the points. For example, if the points lie on a line (and are not all @@ -900,7 +900,7 @@

        Documentation Version
        -classmethod are_coplanar(*points)[source]
        +classmethod are_coplanar(*points)[source]

        Return True if there exists a plane in which all the points lie. A trivial True value is returned if \(len(points) < 3\) or all Points are 2-dimensional.

        @@ -932,7 +932,7 @@
        Documentation Version
        -canberra_distance(p)[source]
        +canberra_distance(p)[source]

        The Canberra Distance from self to point p.

        Returns the weighted sum of horizontal and vertical distances to point p.

        @@ -967,7 +967,7 @@
        Documentation Version
        -distance(other)[source]
        +distance(other)[source]

        The Euclidean distance between self and another GeometricEntity.

        Returns:
        @@ -1005,19 +1005,19 @@
        Documentation Version
        -dot(p)[source]
        +dot(p)[source]

        Return dot product of self with another Point.

        -equals(other)[source]
        +equals(other)[source]

        Returns whether the coordinates of self and other agree.

        -intersection(other)[source]
        +intersection(other)[source]

        The intersection between this point and another GeometryEntity.

        Parameters:
        @@ -1043,7 +1043,7 @@
        Documentation Version
        -is_collinear(*args)[source]
        +is_collinear(*args)[source]

        Returns \(True\) if there exists a line that contains \(self\) and \(points\). Returns \(False\) otherwise. A trivially True value is returned if no points are given.

        @@ -1074,7 +1074,7 @@
        Documentation Version
        -is_concyclic(*args)[source]
        +is_concyclic(*args)[source]

        Do \(self\) and the given sequence of points lie in a circle?

        Returns True if the set of points are concyclic and False otherwise. A trivial value of True is returned @@ -1118,7 +1118,7 @@

        Documentation Version
        -is_scalar_multiple(p)[source]
        +is_scalar_multiple(p)[source]

        Returns whether each coordinate of \(self\) is a scalar multiple of the corresponding coordinate in point p.

        @@ -1145,7 +1145,7 @@
        Documentation Version
        -midpoint(p)[source]
        +midpoint(p)[source]

        The midpoint between self and point p.

        Parameters:
        @@ -1194,7 +1194,7 @@
        Documentation Version
        -static project(a, b)[source]
        +static project(a, b)[source]

        Project the point \(a\) onto the line between the origin and point \(b\) along the normal direction.

        @@ -1226,7 +1226,7 @@
        Documentation Version
        -taxicab_distance(p)[source]
        +taxicab_distance(p)[source]

        The Taxicab Distance from self to point p.

        Returns the sum of the horizontal and vertical distances to point p.

        @@ -1262,7 +1262,7 @@
        Documentation Version
        -class sympy.geometry.point.Point2D(*args, _nocheck=False, **kwargs)[source]
        +class sympy.geometry.point.Point2D(*args, _nocheck=False, **kwargs)[source]

        A point in a 2-dimensional Euclidean space.

        Parameters:
        @@ -1344,7 +1344,7 @@
        Documentation Version
        -rotate(angle, pt=None)[source]
        +rotate(angle, pt=None)[source]

        Rotate angle radians counterclockwise about Point pt.

        Examples

        >>> from sympy import Point2D, pi
        @@ -1363,7 +1363,7 @@ 
        Documentation Version
        -scale(x=1, y=1, pt=None)[source]
        +scale(x=1, y=1, pt=None)[source]

        Scale the coordinates of the Point by multiplying by x and y after subtracting pt – default is (0, 0) – and then adding pt back again (i.e. pt is the point of @@ -1385,7 +1385,7 @@

        Documentation Version
        -transform(matrix)[source]
        +transform(matrix)[source]

        Return the point after applying the transformation described by the 3x3 Matrix, matrix.

        @@ -1396,7 +1396,7 @@
        Documentation Version
        -translate(x=0, y=0)[source]
        +translate(x=0, y=0)[source]

        Shift the Point by adding x and y to the coordinates of the Point.

        Examples

        >>> from sympy import Point2D
        @@ -1445,7 +1445,7 @@ 
        Documentation Version
        -class sympy.geometry.point.Point3D(*args, _nocheck=False, **kwargs)[source]
        +class sympy.geometry.point.Point3D(*args, _nocheck=False, **kwargs)[source]

        A point in a 3-dimensional Euclidean space.

        Parameters:
        @@ -1502,7 +1502,7 @@
        Documentation Version
        -static are_collinear(*points)[source]
        +static are_collinear(*points)[source]

        Is a sequence of points collinear?

        Test whether or not a set of points are collinear. Returns True if the set of points are collinear, or False otherwise.

        @@ -1546,7 +1546,7 @@
        Documentation Version
        -direction_cosine(point)[source]
        +direction_cosine(point)[source]

        Gives the direction cosine between 2 points

        Parameters:
        @@ -1567,7 +1567,7 @@
        Documentation Version
        -direction_ratio(point)[source]
        +direction_ratio(point)[source]

        Gives the direction ratio between 2 points

        Parameters:
        @@ -1588,7 +1588,7 @@
        Documentation Version
        -intersection(other)[source]
        +intersection(other)[source]

        The intersection between this point and another GeometryEntity.

        Parameters:
        @@ -1614,7 +1614,7 @@
        Documentation Version
        -scale(x=1, y=1, z=1, pt=None)[source]
        +scale(x=1, y=1, z=1, pt=None)[source]

        Scale the coordinates of the Point by multiplying by x and y after subtracting pt – default is (0, 0) – and then adding pt back again (i.e. pt is the point of @@ -1636,7 +1636,7 @@

        Documentation Version
        -transform(matrix)[source]
        +transform(matrix)[source]

        Return the point after applying the transformation described by the 4x4 Matrix, matrix.

        @@ -1647,7 +1647,7 @@
        Documentation Version
        -translate(x=0, y=0, z=0)[source]
        +translate(x=0, y=0, z=0)[source]

        Shift the Point by adding x and y to the coordinates of the Point.

        Examples

        >>> from sympy import Point3D
        diff --git a/dev/modules/geometry/polygons.html b/dev/modules/geometry/polygons.html
        index 44eb7c4c209..c55a79c5cbc 100644
        --- a/dev/modules/geometry/polygons.html
        +++ b/dev/modules/geometry/polygons.html
        @@ -805,7 +805,7 @@ 
        Documentation Version

        Polygons

        -class sympy.geometry.polygon.Polygon(*args, n=0, **kwargs)[source]
        +class sympy.geometry.polygon.Polygon(*args, n=0, **kwargs)[source]

        A two-dimensional polygon.

        A simple polygon in space. Can be constructed from a sequence of points or from a center, radius, number of sides and rotation angle.

        @@ -936,7 +936,7 @@
        Documentation Version
        -arbitrary_point(parameter='t')[source]
        +arbitrary_point(parameter='t')[source]

        A parameterized point on the polygon.

        The parameter, varying from 0 to 1, assigns points to the position on the perimeter that is that fraction of the total perimeter. So the @@ -1014,7 +1014,7 @@

        Documentation Version
        -bisectors(prec=None)[source]
        +bisectors(prec=None)[source]

        Returns angle bisectors of a polygon. If prec is given then approximate the point defining the ray to that precision.

        The distance between the points defining the bisector ray is 1.

        @@ -1062,7 +1062,7 @@
        Documentation Version
        -cut_section(line)[source]
        +cut_section(line)[source]

        Returns a tuple of two polygon segments that lie above and below the intersecting line respectively.

        @@ -1115,7 +1115,7 @@
        Documentation Version
        -distance(o)[source]
        +distance(o)[source]

        Returns the shortest distance between self and o.

        If o is a point, then self does not need to be convex. If o is another polygon self and o must be convex.

        @@ -1131,7 +1131,7 @@
        Documentation Version
        -encloses_point(p)[source]
        +encloses_point(p)[source]

        Return True if p is enclosed by (is inside of) self.

        Parameters:
        @@ -1169,7 +1169,7 @@
        Documentation Version
        -first_moment_of_area(point=None)[source]
        +first_moment_of_area(point=None)[source]

        Returns the first moment of area of a two-dimensional polygon with respect to a certain point of interest.

        First moment of area is a measure of the distribution of the area @@ -1224,7 +1224,7 @@

        Documentation Version
        -intersection(o)[source]
        +intersection(o)[source]

        The intersection of polygon and geometry entity.

        The intersection may be empty and can contain individual Points and complete Line Segments.

        @@ -1261,7 +1261,7 @@
        Documentation Version
        -is_convex()[source]
        +is_convex()[source]

        Is the polygon convex?

        A polygon is convex if all its interior angles are less than 180 degrees and there are no intersections between sides.

        @@ -1312,7 +1312,7 @@
        Documentation Version
        -plot_interval(parameter='t')[source]
        +plot_interval(parameter='t')[source]

        The plot interval for the default geometric plot of the polygon.

        Parameters:
        @@ -1339,7 +1339,7 @@
        Documentation Version
        -polar_second_moment_of_area()[source]
        +polar_second_moment_of_area()[source]

        Returns the polar modulus of a two-dimensional polygon

        It is a constituent of the second moment of area, linked through the perpendicular axis theorem. While the planar second moment of @@ -1368,7 +1368,7 @@

        Documentation Version
        -second_moment_of_area(point=None)[source]
        +second_moment_of_area(point=None)[source]

        Returns the second moment and product moment of area of a two dimensional polygon.

        Parameters:
        @@ -1409,7 +1409,7 @@
        Documentation Version
        -section_modulus(point=None)[source]
        +section_modulus(point=None)[source]

        Returns a tuple with the section modulus of a two-dimensional polygon.

        Section modulus is a geometric property of a polygon defined as the @@ -1515,7 +1515,7 @@

        Documentation Version
        -class sympy.geometry.polygon.RegularPolygon(c, r, n, rot=0, **kwargs)[source]
        +class sympy.geometry.polygon.RegularPolygon(c, r, n, rot=0, **kwargs)[source]

        A regular polygon.

        Such a polygon has all internal angles equal and all sides the same length.

        @@ -1761,7 +1761,7 @@
        Documentation Version
        -encloses_point(p)[source]
        +encloses_point(p)[source]

        Return True if p is enclosed by (is inside of) self.

        Parameters:
        @@ -1926,7 +1926,7 @@
        Documentation Version
        -reflect(line)[source]
        +reflect(line)[source]

        Override GeometryEntity.reflect since this is not made of only points.

        Examples

        @@ -1941,7 +1941,7 @@
        Documentation Version
        -rotate(angle, pt=None)[source]
        +rotate(angle, pt=None)[source]

        Override GeometryEntity.rotate to first rotate the RegularPolygon about its center.

        >>> from sympy import Point, RegularPolygon, pi
        @@ -1990,7 +1990,7 @@ 
        Documentation Version
        -scale(x=1, y=1, pt=None)[source]
        +scale(x=1, y=1, pt=None)[source]

        Override GeometryEntity.scale since it is the radius that must be scaled (if x == y) or else a new Polygon must be returned.

        >>> from sympy import RegularPolygon
        @@ -2010,7 +2010,7 @@ 
        Documentation Version
        -spin(angle)[source]
        +spin(angle)[source]

        Increment in place the virtual Polygon’s rotation by ccw angle.

        See also: rotate method which moves the center.

        >>> from sympy import Polygon, Point, pi
        @@ -2061,7 +2061,7 @@ 
        Documentation Version
        -class sympy.geometry.polygon.Triangle(*args, **kwargs)[source]
        +class sympy.geometry.polygon.Triangle(*args, **kwargs)[source]

        A polygon with three vertices and three sides.

        Parameters:
        @@ -2172,7 +2172,7 @@
        Documentation Version
        -bisectors()[source]
        +bisectors()[source]

        The angle bisectors of the triangle.

        An angle bisector of a triangle is a straight line through a vertex which cuts the corresponding angle in half.

        @@ -2444,7 +2444,7 @@
        Documentation Version
        -is_equilateral()[source]
        +is_equilateral()[source]

        Are all the sides the same length?

        Returns:
        @@ -2472,7 +2472,7 @@
        Documentation Version
        -is_isosceles()[source]
        +is_isosceles()[source]

        Are two or more of the sides the same length?

        Returns:
        @@ -2494,7 +2494,7 @@
        Documentation Version
        -is_right()[source]
        +is_right()[source]

        Is the triangle right-angled.

        Returns:
        @@ -2516,7 +2516,7 @@
        Documentation Version
        -is_scalene()[source]
        +is_scalene()[source]

        Are all the sides of the triangle of different lengths?

        Returns:
        @@ -2538,7 +2538,7 @@
        Documentation Version
        -is_similar(t2)[source]
        +is_similar(t2)[source]

        Is another triangle similar to this one.

        Two triangles are similar if one can be uniformly scaled to the other.

        diff --git a/dev/modules/geometry/utils.html b/dev/modules/geometry/utils.html index 348229b9ba5..c4bfa15041f 100644 --- a/dev/modules/geometry/utils.html +++ b/dev/modules/geometry/utils.html @@ -805,7 +805,7 @@
        Documentation Version

        Utils

        -sympy.geometry.util.intersection(*entities, pairwise=False, **kwargs)[source]
        +sympy.geometry.util.intersection(*entities, pairwise=False, **kwargs)[source]

        The intersection of a collection of GeometryEntity instances.

        Parameters:
        @@ -862,7 +862,7 @@
        Documentation Version
        -sympy.geometry.util.convex_hull(*args, polygon=True)[source]
        +sympy.geometry.util.convex_hull(*args, polygon=True)[source]

        The convex hull surrounding the Points contained in the list of entities.

        Parameters:
        @@ -915,7 +915,7 @@
        Documentation Version
        -sympy.geometry.util.are_similar(e1, e2)[source]
        +sympy.geometry.util.are_similar(e1, e2)[source]

        Are two geometrical entities similar.

        Can one geometrical entity be uniformly scaled to the other?

        @@ -955,7 +955,7 @@
        Documentation Version
        -sympy.geometry.util.centroid(*args)[source]
        +sympy.geometry.util.centroid(*args)[source]

        Find the centroid (center of mass) of the collection containing only Points, Segments or Polygons. The centroid is the weighted average of the individual centroid where the weights are the lengths (of segments) or areas (of polygons). @@ -1001,7 +1001,7 @@

        Documentation Version
        -sympy.geometry.util.idiff(eq, y, x, n=1)[source]
        +sympy.geometry.util.idiff(eq, y, x, n=1)[source]

        Return dy/dx assuming that eq == 0.

        Parameters:
        diff --git a/dev/modules/holonomic/convert.html b/dev/modules/holonomic/convert.html index 4dec9c946d9..f85f5351020 100644 --- a/dev/modules/holonomic/convert.html +++ b/dev/modules/holonomic/convert.html @@ -807,7 +807,7 @@

        Converting other representations to holonomic

        -sympy.holonomic.holonomic.from_hyper(func, x0=0, evalf=False)[source]
        +sympy.holonomic.holonomic.from_hyper(func, x0=0, evalf=False)[source]

        Converts a hypergeometric function to holonomic. func is the Hypergeometric Function and x0 is the point at which initial conditions are required.

        @@ -836,7 +836,7 @@

        Converting Meijer G-functionsdomain=QQ,

        -)[source] +)[source]

        Converts a Meijer G-function to Holonomic. func is the G-Function and x0 is the point at which initial conditions are required.

        @@ -867,7 +867,7 @@

        Converting symbolic expressionsinitcond=True,

        -)[source] +)[source]

        Converts a function or an expression to a holonomic function.

        Parameters:
        diff --git a/dev/modules/holonomic/internal.html b/dev/modules/holonomic/internal.html index 1258f4542ef..70b2bc23933 100644 --- a/dev/modules/holonomic/internal.html +++ b/dev/modules/holonomic/internal.html @@ -805,7 +805,7 @@
        Documentation Version

        Internal API

        -sympy.holonomic.holonomic._create_table(table, domain=QQ)[source]
        +sympy.holonomic.holonomic._create_table(table, domain=QQ)[source]

        Creates the look-up table. For a similar implementation see meijerint._create_lookup_table.

        @@ -824,7 +824,7 @@

        Internal APIinitcond=True,

        -)[source] +)[source]

        Converts polynomials, rationals and algebraic functions to holonomic.

        diff --git a/dev/modules/holonomic/operations.html b/dev/modules/holonomic/operations.html index d1ed1bb0f48..3ed52bf6448 100644 --- a/dev/modules/holonomic/operations.html +++ b/dev/modules/holonomic/operations.html @@ -844,7 +844,7 @@

        Integration and Differentiationinitcond=False,

        -)[source] +)[source]

        Integrates the given holonomic function.

        Examples

        >>> from sympy.holonomic.holonomic import HolonomicFunction, DifferentialOperators
        @@ -862,7 +862,7 @@ 

        Integration and Differentiation
        -HolonomicFunction.diff(*args, **kwargs)[source]
        +HolonomicFunction.diff(*args, **kwargs)[source]

        Differentiation of the given Holonomic function.

        Examples

        >>> from sympy.holonomic.holonomic import HolonomicFunction, DifferentialOperators
        @@ -895,7 +895,7 @@ 

        Composition with polynomials**kwargs,

        -)[source] +)[source]

        Returns function after composition of a holonomic function with an algebraic function. The method cannot compute initial conditions for the result by itself, so they can be also be @@ -923,7 +923,7 @@

        Composition with polynomials

        -HolonomicFunction.to_sequence(lb=True)[source]
        +HolonomicFunction.to_sequence(lb=True)[source]

        Finds recurrence relation for the coefficients in the series expansion of the function about \(x_0\), where \(x_0\) is the point at which the initial condition is stored.

        @@ -985,7 +985,7 @@

        Series expansion_recur=None,

        -)[source] +)[source]

        Finds the power series expansion of given holonomic function about \(x_0\).

        Explanation

        A list of series might be returned if \(x_0\) is a regular point with @@ -1022,7 +1022,7 @@

        Numerical evaluationderivatives=False,

        -)[source] +)[source]

        Finds numerical value of a holonomic function using numerical methods. (RK4 by default). A set of points (real or complex) must be provided which will be the path for the numerical integration.

        @@ -1073,7 +1073,7 @@

        Convert to a linear combination of hypergeometric functions_recur=None,

        -)[source] +)[source]

        Returns a hypergeometric function (or linear combination of them) representing the given holonomic function.

        Explanation

        @@ -1106,7 +1106,7 @@

        Convert to a linear combination of hypergeometric functions

        -HolonomicFunction.to_meijerg()[source]
        +HolonomicFunction.to_meijerg()[source]

        Returns a linear combination of Meijer G-functions.

        Examples

        >>> from sympy.holonomic import expr_to_holonomic
        @@ -1129,7 +1129,7 @@ 

        Convert to a linear combination of Meijer G-functionsConvert to expressions

        -HolonomicFunction.to_expr()[source]
        +HolonomicFunction.to_expr()[source]

        Converts a Holonomic Function back to elementary functions.

        Examples

        >>> from sympy.holonomic.holonomic import HolonomicFunction, DifferentialOperators
        diff --git a/dev/modules/holonomic/represent.html b/dev/modules/holonomic/represent.html
        index 1b7c3f79fb7..3f4e1428ef2 100644
        --- a/dev/modules/holonomic/represent.html
        +++ b/dev/modules/holonomic/represent.html
        @@ -836,7 +836,7 @@ 

        Representation of holonomic functions in SymPy
        -class sympy.holonomic.holonomic.HolonomicFunction(annihilator, x, x0=0, y0=None)[source]
        +class sympy.holonomic.holonomic.HolonomicFunction(annihilator, x, x0=0, y0=None)[source]

        A Holonomic Function is a solution to a linear homogeneous ordinary differential equation with polynomial coefficients. This differential equation can also be represented by an annihilator i.e. a Differential @@ -901,7 +901,7 @@

        Representation of holonomic functions in SymPy
        -class sympy.holonomic.holonomic.DifferentialOperator(list_of_poly, parent)[source]
        +class sympy.holonomic.holonomic.DifferentialOperator(list_of_poly, parent)[source]

        Differential Operators are elements of Weyl Algebra. The Operators are defined by a list of polynomials in the base ring and the parent ring of the Operator i.e. the algebra it belongs to.

        @@ -932,7 +932,7 @@

        Representation of holonomic functions in SymPy
        -is_singular(x0)[source]
        +is_singular(x0)[source]

        Checks if the differential equation is singular at x0.

        @@ -940,7 +940,7 @@

        Representation of holonomic functions in SymPy
        -sympy.holonomic.holonomic.DifferentialOperators(base, generator)[source]
        +sympy.holonomic.holonomic.DifferentialOperators(base, generator)[source]

        This function is used to create annihilators using Dx.

        Parameters:
        @@ -975,7 +975,7 @@

        Representation of holonomic functions in SymPy
        -class sympy.holonomic.holonomic.DifferentialOperatorAlgebra(base, generator)[source]
        +class sympy.holonomic.holonomic.DifferentialOperatorAlgebra(base, generator)[source]

        An Ore Algebra is a set of noncommutative polynomials in the intermediate Dx and coefficients in a base polynomial ring \(A\). It follows the commutation rule:

        diff --git a/dev/modules/integrals/g-functions.html b/dev/modules/integrals/g-functions.html index ffe7afed2dd..972ee2e8f35 100644 --- a/dev/modules/integrals/g-functions.html +++ b/dev/modules/integrals/g-functions.html @@ -1814,19 +1814,19 @@

        Implemented G-Function Formulae
        -exception sympy.integrals.meijerint._CoeffExpValueError[source]
        +exception sympy.integrals.meijerint._CoeffExpValueError[source]

        Exception raised by _get_coeff_exp, for internal use only.

        -sympy.integrals.meijerint._check_antecedents(g1, g2, x)[source]
        +sympy.integrals.meijerint._check_antecedents(g1, g2, x)[source]

        Return a condition under which the integral theorem applies.

        -sympy.integrals.meijerint._check_antecedents_1(g, x, helper=False)[source]
        +sympy.integrals.meijerint._check_antecedents_1(g, x, helper=False)[source]

        Return a condition under which the mellin transform of g exists. Any power of x has already been absorbed into the G function, so this is just \(\int_0^\infty g\, dx\).

        @@ -1837,13 +1837,13 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._check_antecedents_inversion(g, x)[source]
        +sympy.integrals.meijerint._check_antecedents_inversion(g, x)[source]

        Check antecedents for the laplace inversion integral.

        -sympy.integrals.meijerint._condsimp(cond, first=True)[source]
        +sympy.integrals.meijerint._condsimp(cond, first=True)[source]

        Do naive simplifications on cond.

        Explanation

        Note that this routine is completely ad-hoc, simplification rules being @@ -1860,13 +1860,13 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._create_lookup_table(table)[source]
        +sympy.integrals.meijerint._create_lookup_table(table)[source]

        Add formulae for the function -> meijerg lookup table.

        -sympy.integrals.meijerint._dummy(name, token, expr, **kwargs)[source]
        +sympy.integrals.meijerint._dummy(name, token, expr, **kwargs)[source]

        Return a dummy. This will return the same dummy if the same token+name is requested more than once, and it is not already in expr. This is for being cache-friendly.

        @@ -1874,20 +1874,20 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._dummy_(name, token, **kwargs)[source]
        +sympy.integrals.meijerint._dummy_(name, token, **kwargs)[source]

        Return a dummy associated to name and token. Same effect as declaring it globally.

        -sympy.integrals.meijerint._eval_cond(cond)[source]
        +sympy.integrals.meijerint._eval_cond(cond)[source]

        Re-evaluate the conditions.

        -sympy.integrals.meijerint._exponents(expr, x)[source]
        +sympy.integrals.meijerint._exponents(expr, x)[source]

        Find the exponents of x (not including zero) in expr.

        Examples

        >>> from sympy.integrals.meijerint import _exponents
        @@ -1907,7 +1907,7 @@ 

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._find_splitting_points(expr, x)[source]
        +sympy.integrals.meijerint._find_splitting_points(expr, x)[source]

        Find numbers a such that a linear substitution x -> x + a would (hopefully) simplify expr.

        Examples

        @@ -1926,20 +1926,20 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._flip_g(g)[source]
        +sympy.integrals.meijerint._flip_g(g)[source]

        Turn the G function into one of inverse argument (i.e. G(1/x) -> G’(x))

        -sympy.integrals.meijerint._functions(expr, x)[source]
        +sympy.integrals.meijerint._functions(expr, x)[source]

        Find the types of functions in expr, to estimate the complexity.

        -sympy.integrals.meijerint._get_coeff_exp(expr, x)[source]
        +sympy.integrals.meijerint._get_coeff_exp(expr, x)[source]

        When expr is known to be of the form c*x**b, with c and/or b possibly 1, return c, b.

        Examples

        @@ -1959,13 +1959,13 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._guess_expansion(f, x)[source]
        +sympy.integrals.meijerint._guess_expansion(f, x)[source]

        Try to guess sensible rewritings for integrand f(x).

        -sympy.integrals.meijerint._inflate_fox_h(g, a)[source]
        +sympy.integrals.meijerint._inflate_fox_h(g, a)[source]

        Let d denote the integrand in the definition of the G function g. Consider the function H which is defined in the same way, but with integrand d/Gamma(a*s) (contour conventions as usual).

        @@ -1976,14 +1976,14 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._inflate_g(g, n)[source]
        +sympy.integrals.meijerint._inflate_g(g, n)[source]

        Return C, h such that h is a G function of argument z**n and g = C*h.

        -sympy.integrals.meijerint._int0oo(g1, g2, x)[source]
        +sympy.integrals.meijerint._int0oo(g1, g2, x)[source]

        Express integral from zero to infinity g1*g2 using a G function, assuming the necessary conditions are fulfilled.

        Examples

        @@ -2000,7 +2000,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._int0oo_1(g, x)[source]
        +sympy.integrals.meijerint._int0oo_1(g, x)[source]

        Evaluate \(\int_0^\infty g\, dx\) using G functions, assuming the necessary conditions are fulfilled.

        Examples

        @@ -2015,20 +2015,20 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._int_inversion(g, x, t)[source]
        +sympy.integrals.meijerint._int_inversion(g, x, t)[source]

        Compute the laplace inversion integral, assuming the formula applies.

        -sympy.integrals.meijerint._is_analytic(f, x)[source]
        +sympy.integrals.meijerint._is_analytic(f, x)[source]

        Check if f(x), when expressed using G functions on the positive reals, will in fact agree with the G functions almost everywhere

        -sympy.integrals.meijerint._meijerint_definite_2(f, x)[source]
        +sympy.integrals.meijerint._meijerint_definite_2(f, x)[source]

        Try to integrate f dx from zero to infinity.

        The body of this function computes various ‘simplifications’ f1, f2, … of f (e.g. by calling expand_mul(), trigexpand() @@ -2040,7 +2040,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._meijerint_definite_3(f, x)[source]
        +sympy.integrals.meijerint._meijerint_definite_3(f, x)[source]

        Try to integrate f dx from zero to infinity.

        This function calls _meijerint_definite_4 to try to compute the integral. If this fails, it tries using linearity.

        @@ -2048,7 +2048,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._meijerint_definite_4(f, x, only_double=False)[source]
        +sympy.integrals.meijerint._meijerint_definite_4(f, x, only_double=False)[source]

        Try to integrate f dx from zero to infinity.

        Explanation

        This function tries to apply the integration theorems found in literature, @@ -2059,13 +2059,13 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._meijerint_indefinite_1(f, x)[source]
        +sympy.integrals.meijerint._meijerint_indefinite_1(f, x)[source]

        Helper that does not attempt any substitution.

        -sympy.integrals.meijerint._mul_args(f)[source]
        +sympy.integrals.meijerint._mul_args(f)[source]

        Return a list L such that Mul(*L) == f.

        If f is not a Mul or Pow, L=[f]. If f=g**n for an integer n, L=[g]*n. @@ -2074,7 +2074,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._mul_as_two_parts(f)[source]
        +sympy.integrals.meijerint._mul_as_two_parts(f)[source]

        Find all the ways to split f into a product of two terms. Return None on failure.

        Explanation

        @@ -2094,7 +2094,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._my_principal_branch(expr, period, full_pb=False)[source]
        +sympy.integrals.meijerint._my_principal_branch(expr, period, full_pb=False)[source]

        Bring expr nearer to its principal branch by removing superfluous factors. This function does not guarantee to yield the principal branch, @@ -2111,13 +2111,13 @@

        Implemented G-Function Formulaex: Symbol,

        -) tuple[type[Basic], ...][source] +) tuple[type[Basic], ...][source]

        Create a hashable entity describing the type of f.

        -sympy.integrals.meijerint._rewrite1(f, x, recursive=True)[source]
        +sympy.integrals.meijerint._rewrite1(f, x, recursive=True)[source]

        Try to rewrite f using a (sum of) single G functions with argument a*x**b. Return fac, po, g such that f = fac*po*g, fac is independent of x. and po = x**s. @@ -2127,7 +2127,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._rewrite2(f, x)[source]
        +sympy.integrals.meijerint._rewrite2(f, x)[source]

        Try to rewrite f as a product of two G functions of arguments a*x**b. Return fac, po, g1, g2 such that f = fac*po*g1*g2, where fac is independent of x and po is x**s. @@ -2137,13 +2137,13 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._rewrite_inversion(fac, po, g, x)[source]
        +sympy.integrals.meijerint._rewrite_inversion(fac, po, g, x)[source]

        Absorb po == x**s into g.

        -sympy.integrals.meijerint._rewrite_saxena(fac, po, g1, g2, x, full_pb=False)[source]
        +sympy.integrals.meijerint._rewrite_saxena(fac, po, g1, g2, x, full_pb=False)[source]

        Rewrite the integral fac*po*g1*g2 from 0 to oo in terms of G functions with argument c*x.

        Explanation

        @@ -2168,7 +2168,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._rewrite_saxena_1(fac, po, g, x)[source]
        +sympy.integrals.meijerint._rewrite_saxena_1(fac, po, g, x)[source]

        Rewrite the integral fac*po*g dx, from zero to infinity, as integral fac*G, where G has argument a*x. Note po=x**s. Return fac, G.

        @@ -2176,7 +2176,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._rewrite_single(f, x, recursive=True)[source]
        +sympy.integrals.meijerint._rewrite_single(f, x, recursive=True)[source]

        Try to rewrite f as a sum of single G functions of the form C*x**s*G(a*x**b), where b is a rational number and C is independent of x. We guarantee that result.argument.as_coeff_mul(x) returns (a, (x**b,)) @@ -2187,7 +2187,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint._split_mul(f, x)[source]
        +sympy.integrals.meijerint._split_mul(f, x)[source]

        Split expression f into fac, po, g, where fac is a constant factor, po = x**s for some s independent of s, and g is “the rest”.

        Examples

        @@ -2202,7 +2202,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint.meijerint_definite(f, x, a, b)[source]
        +sympy.integrals.meijerint.meijerint_definite(f, x, a, b)[source]

        Integrate f over the interval [a, b], by rewriting it as a product of two G functions, or as a single G function.

        Return res, cond, where cond are convergence conditions.

        @@ -2223,7 +2223,7 @@

        Implemented G-Function Formulae
        -sympy.integrals.meijerint.meijerint_indefinite(f, x)[source]
        +sympy.integrals.meijerint.meijerint_indefinite(f, x)[source]

        Compute an indefinite integral of f by rewriting it as a G function.

        Examples

        >>> from sympy.integrals.meijerint import meijerint_indefinite
        @@ -2237,7 +2237,7 @@ 

        Implemented G-Function Formulae
        -sympy.integrals.meijerint.meijerint_inversion(f, x, t)[source]
        +sympy.integrals.meijerint.meijerint_inversion(f, x, t)[source]

        Compute the inverse laplace transform \(\int_{c+i\infty}^{c-i\infty} f(x) e^{tx}\, dx\), for real c larger than the real part of all singularities of f.

        diff --git a/dev/modules/integrals/integrals.html b/dev/modules/integrals/integrals.html index 417dfbf31e8..42eb48af3f0 100644 --- a/dev/modules/integrals/integrals.html +++ b/dev/modules/integrals/integrals.html @@ -853,7 +853,7 @@

        Examples

        SymPy has special support for definite integrals, and integral transforms.

        -sympy.integrals.transforms.mellin_transform(f, x, s, **hints)[source]
        +sympy.integrals.transforms.mellin_transform(f, x, s, **hints)[source]

        Compute the Mellin transform \(F(s)\) of \(f(x)\),

        @@ -890,7 +890,7 @@

        Examples
        -class sympy.integrals.transforms.MellinTransform(*args)[source]
        +class sympy.integrals.transforms.MellinTransform(*args)[source]

        Class representing unevaluated Mellin transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute Mellin transforms, see the mellin_transform() @@ -899,7 +899,7 @@

        Examples
        -sympy.integrals.transforms.inverse_mellin_transform(F, s, x, strip, **hints)[source]
        +sympy.integrals.transforms.inverse_mellin_transform(F, s, x, strip, **hints)[source]

        Compute the inverse Mellin transform of \(F(s)\) over the fundamental strip given by strip=(a, b).

        Explanation

        @@ -945,7 +945,7 @@

        Examples
        -class sympy.integrals.transforms.InverseMellinTransform(*args)[source]
        +class sympy.integrals.transforms.InverseMellinTransform(*args)[source]

        Class representing unevaluated inverse Mellin transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute inverse Mellin transforms, see the @@ -964,7 +964,7 @@

        Examples
        **hints,

        -)[source] +)[source]

        Compute the Laplace Transform \(F(s)\) of \(f(t)\),

        @@ -1063,7 +1063,7 @@

        Examples
        -sympy.integrals.transforms.laplace_correspondence(f, fdict, /)[source]
        +sympy.integrals.transforms.laplace_correspondence(f, fdict, /)[source]

        This helper function takes a function \(f\) that is the result of a laplace_transform or an inverse_laplace_transform. It replaces all unevaluated LaplaceTransform(y(t), t, s) by \(Y(s)\) for any \(s\) and @@ -1104,7 +1104,7 @@

        Examples
        -sympy.integrals.transforms.laplace_initial_conds(f, t, fdict, /)[source]
        +sympy.integrals.transforms.laplace_initial_conds(f, t, fdict, /)[source]

        This helper function takes a function \(f\) that is the result of a laplace_transform. It takes an fdict of the form {y: [1, 4, 2]}, where the values in the list are the initial value, the initial slope, the @@ -1145,7 +1145,7 @@

        Examples
        -class sympy.integrals.transforms.LaplaceTransform(*args)[source]
        +class sympy.integrals.transforms.LaplaceTransform(*args)[source]

        Class representing unevaluated Laplace transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute Laplace transforms, see the laplace_transform() @@ -1155,7 +1155,7 @@

        Examples tuple containing the same expression, a convergence plane, and conditions.

        -doit(**hints)[source]
        +doit(**hints)[source]

        Try to evaluate the transform in closed form.

        Explanation

        Standard hints are the following: @@ -1179,7 +1179,7 @@

        Examples
        **hints,

        -)[source] +)[source]

        Compute the inverse Laplace transform of \(F(s)\), defined as

        @@ -1216,14 +1216,14 @@

        Examples
        -class sympy.integrals.transforms.InverseLaplaceTransform(*args)[source]
        +class sympy.integrals.transforms.InverseLaplaceTransform(*args)[source]

        Class representing unevaluated inverse Laplace transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute inverse Laplace transforms, see the inverse_laplace_transform() docstring.

        -doit(**hints)[source]
        +doit(**hints)[source]

        Try to evaluate the transform in closed form.

        Explanation

        Standard hints are the following: @@ -1237,7 +1237,7 @@

        Examples
        -sympy.integrals.transforms.fourier_transform(f, x, k, **hints)[source]
        +sympy.integrals.transforms.fourier_transform(f, x, k, **hints)[source]

        Compute the unitary, ordinary-frequency Fourier transform of f, defined as

        @@ -1281,7 +1281,7 @@

        Examples
        simplify=True,

        -)[source] +)[source]

        Compute a general Fourier-type transform

        @@ -1293,7 +1293,7 @@

        Examples
        -class sympy.integrals.transforms.FourierTransform(*args)[source]
        +class sympy.integrals.transforms.FourierTransform(*args)[source]

        Class representing unevaluated Fourier transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute Fourier transforms, see the fourier_transform() @@ -1302,7 +1302,7 @@

        Examples
        -sympy.integrals.transforms.inverse_fourier_transform(F, k, x, **hints)[source]
        +sympy.integrals.transforms.inverse_fourier_transform(F, k, x, **hints)[source]

        Compute the unitary, ordinary-frequency inverse Fourier transform of \(F\), defined as

        @@ -1334,7 +1334,7 @@

        Examples
        -class sympy.integrals.transforms.InverseFourierTransform(*args)[source]
        +class sympy.integrals.transforms.InverseFourierTransform(*args)[source]

        Class representing unevaluated inverse Fourier transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute inverse Fourier transforms, see the @@ -1343,7 +1343,7 @@

        Examples
        -sympy.integrals.transforms.sine_transform(f, x, k, **hints)[source]
        +sympy.integrals.transforms.sine_transform(f, x, k, **hints)[source]

        Compute the unitary, ordinary-frequency sine transform of \(f\), defined as

        @@ -1373,7 +1373,7 @@

        Examples
        -class sympy.integrals.transforms.SineTransform(*args)[source]
        +class sympy.integrals.transforms.SineTransform(*args)[source]

        Class representing unevaluated sine transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute sine transforms, see the sine_transform() @@ -1382,7 +1382,7 @@

        Examples
        -sympy.integrals.transforms.inverse_sine_transform(F, k, x, **hints)[source]
        +sympy.integrals.transforms.inverse_sine_transform(F, k, x, **hints)[source]

        Compute the unitary, ordinary-frequency inverse sine transform of \(F\), defined as

        @@ -1413,7 +1413,7 @@

        Examples
        -class sympy.integrals.transforms.InverseSineTransform(*args)[source]
        +class sympy.integrals.transforms.InverseSineTransform(*args)[source]

        Class representing unevaluated inverse sine transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute inverse sine transforms, see the @@ -1422,7 +1422,7 @@

        Examples
        -sympy.integrals.transforms.cosine_transform(f, x, k, **hints)[source]
        +sympy.integrals.transforms.cosine_transform(f, x, k, **hints)[source]

        Compute the unitary, ordinary-frequency cosine transform of \(f\), defined as

        @@ -1452,7 +1452,7 @@

        Examples
        -class sympy.integrals.transforms.CosineTransform(*args)[source]
        +class sympy.integrals.transforms.CosineTransform(*args)[source]

        Class representing unevaluated cosine transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute cosine transforms, see the cosine_transform() @@ -1461,7 +1461,7 @@

        Examples
        -sympy.integrals.transforms.inverse_cosine_transform(F, k, x, **hints)[source]
        +sympy.integrals.transforms.inverse_cosine_transform(F, k, x, **hints)[source]

        Compute the unitary, ordinary-frequency inverse cosine transform of \(F\), defined as

        @@ -1491,7 +1491,7 @@

        Examples
        -class sympy.integrals.transforms.InverseCosineTransform(*args)[source]
        +class sympy.integrals.transforms.InverseCosineTransform(*args)[source]

        Class representing unevaluated inverse cosine transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute inverse cosine transforms, see the @@ -1500,7 +1500,7 @@

        Examples
        -sympy.integrals.transforms.hankel_transform(f, r, k, nu, **hints)[source]
        +sympy.integrals.transforms.hankel_transform(f, r, k, nu, **hints)[source]

        Compute the Hankel transform of \(f\), defined as

        @@ -1544,7 +1544,7 @@

        Examples
        -class sympy.integrals.transforms.HankelTransform(*args)[source]
        +class sympy.integrals.transforms.HankelTransform(*args)[source]

        Class representing unevaluated Hankel transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute Hankel transforms, see the hankel_transform() @@ -1553,7 +1553,7 @@

        Examples
        -sympy.integrals.transforms.inverse_hankel_transform(F, k, r, nu, **hints)[source]
        +sympy.integrals.transforms.inverse_hankel_transform(F, k, r, nu, **hints)[source]

        Compute the inverse Hankel transform of \(F\) defined as

        @@ -1597,7 +1597,7 @@

        Examples
        -class sympy.integrals.transforms.InverseHankelTransform(*args)[source]
        +class sympy.integrals.transforms.InverseHankelTransform(*args)[source]

        Class representing unevaluated inverse Hankel transforms.

        For usage of this class, see the IntegralTransform docstring.

        For how to compute inverse Hankel transforms, see the @@ -1606,7 +1606,7 @@

        Examples
        -class sympy.integrals.transforms.IntegralTransform(*args)[source]
        +class sympy.integrals.transforms.IntegralTransform(*args)[source]

        Base class for integral transforms.

        Explanation

        This class represents unevaluated transforms.

        @@ -1623,7 +1623,7 @@

        Examples number and possibly a convergence condition.

        -doit(**hints)[source]
        +doit(**hints)[source]

        Try to evaluate the transform in closed form.

        Explanation

        This general function handles linearity, but apart from that leaves @@ -1665,7 +1665,7 @@

        Examples
        -exception sympy.integrals.transforms.IntegralTransformError(transform, function, msg)[source]
        +exception sympy.integrals.transforms.IntegralTransformError(transform, function, msg)[source]

        Exception raised in relation to problems computing transforms.

        Explanation

        This class is mostly used internally; if integrals cannot be computed @@ -1688,7 +1688,7 @@

        Internalsratint().

        -sympy.integrals.rationaltools.ratint(f, x, **flags)[source]
        +sympy.integrals.rationaltools.ratint(f, x, **flags)[source]

        Performs indefinite integration of rational functions.

        Explanation

        Given a field \(K\) and a rational function \(f = p/q\), @@ -1719,7 +1719,7 @@

        Internals
        -sympy.integrals.rationaltools.ratint_ratpart(f, g, x)[source]
        +sympy.integrals.rationaltools.ratint_ratpart(f, g, x)[source]

        Horowitz-Ostrogradsky algorithm.

        Explanation

        Given a field K and polynomials f and g in K[x], such that f and g @@ -1748,7 +1748,7 @@

        Internals
        -sympy.integrals.rationaltools.ratint_logpart(f, g, x, t=None)[source]
        +sympy.integrals.rationaltools.ratint_logpart(f, g, x, t=None)[source]

        Lazard-Rioboo-Trager algorithm.

        Explanation

        Given a field K and polynomials f and g in K[x], such that f and g @@ -1787,7 +1787,7 @@

        Internals
        -sympy.integrals.trigonometry.trigintegrate(f, x, conds='piecewise')[source]
        +sympy.integrals.trigonometry.trigintegrate(f, x, conds='piecewise')[source]

        Integrate f = Mul(trig) over x.

        Examples

        >>> from sympy import sin, cos, tan, sec
        @@ -1828,7 +1828,7 @@ 

        Internalsdeltaintegrate() solves integrals with DiracDelta objects.

        -sympy.integrals.deltafunctions.deltaintegrate(f, x)[source]
        +sympy.integrals.deltafunctions.deltaintegrate(f, x)[source]

        Explanation

        The idea for integration is the following:

          @@ -1878,7 +1878,7 @@

          Internalssingularityintegrate() is applied if the function contains a SingularityFunction

          -sympy.integrals.singularityfunctions.singularityintegrate(f, x)[source]
          +sympy.integrals.singularityfunctions.singularityintegrate(f, x)[source]

          This function handles the indefinite integrations of Singularity functions. The integrate function calls this function internally whenever an instance of SingularityFunction is passed as argument.

          @@ -1943,7 +1943,7 @@

          Internalsconds='piecewise',

          -)[source] +)[source]

          The Risch Integration Algorithm.

          Explanation

          Only transcendental functions are supported. Currently, only exponentials @@ -2051,7 +2051,7 @@

          Internals**assumptions,

        -)[source] +)[source]

        Represents a nonelementary Integral.

        Explanation

        If the result of integrate() is an instance of this class, it is @@ -2103,7 +2103,7 @@

        Internalsintegral_steps() function.

        -sympy.integrals.manualintegrate.manualintegrate(f, var)[source]
        +sympy.integrals.manualintegrate.manualintegrate(f, var)[source]

        Explanation

        Compute indefinite integral of a single variable using an algorithm that resembles what a student would do by hand.

        @@ -2146,7 +2146,7 @@

        Internals
        -sympy.integrals.manualintegrate.integral_steps(integrand, symbol, **options)[source]
        +sympy.integrals.manualintegrate.integral_steps(integrand, symbol, **options)[source]

        Returns the steps needed to compute an integral.

        Returns:
        @@ -2206,7 +2206,7 @@

        Internals_try_heurisch=None,

        -)[source] +)[source]

        Compute indefinite integral using heuristic Risch algorithm.

        Explanation

        This is a heuristic approach to indefinite integration in finite @@ -2292,7 +2292,7 @@

        Internals
        -sympy.integrals.heurisch.components(f, x)[source]
        +sympy.integrals.heurisch.components(f, x)[source]

        Returns a set of all functional components of the given expression which includes symbols, function applications and compositions and non-integer powers. Fractional powers are collected with @@ -2320,7 +2320,7 @@

        Internals

        -sympy.integrals.integrals.integrate(f, var, ...)[source]
        +sympy.integrals.integrals.integrate(f, var, ...)[source]

        Deprecated since version 1.6: Using integrate() with Poly is deprecated. Use Poly.integrate() instead. See Using integrate with Poly.

        @@ -2469,7 +2469,7 @@

        API reference
        -sympy.integrals.integrals.line_integrate(field, Curve, variables)[source]
        +sympy.integrals.integrals.line_integrate(field, Curve, variables)[source]

        Compute the line integral.

        Examples

        >>> from sympy import Curve, line_integrate, E, ln
        @@ -2488,7 +2488,7 @@ 

        API referenceIntegral represents an unevaluated integral and has some methods that help in the integration of an expression.

        -class sympy.integrals.integrals.Integral(function, *symbols, **assumptions)[source]
        +class sympy.integrals.integrals.Integral(function, *symbols, **assumptions)[source]

        Represents unevaluated integral.

        @@ -2506,7 +2506,7 @@

        API referenceevaluate=True,

        -)[source] +)[source]

        Approximates a definite integral by a sum.

        Parameters:
        @@ -2617,7 +2617,7 @@

        API reference
        -doit(**hints)[source]
        +doit(**hints)[source]

        Perform the integration using any hints given.

        Examples

        >>> from sympy import Piecewise, S
        @@ -2659,7 +2659,7 @@ 

        API reference
        -principal_value(**kwargs)[source]
        +principal_value(**kwargs)[source]

        Compute the Cauchy Principal Value of the definite integral of a real function in the given interval on the real axis.

        Explanation

        @@ -2694,7 +2694,7 @@

        API reference
        -transform(x, u)[source]
        +transform(x, u)[source]

        Performs a change of variables from \(x\) to \(u\) using the relationship given by \(x\) and \(u\) which will define the transformations \(f\) and \(F\) (which are inverses of each other) as follows:

        @@ -2801,7 +2801,7 @@

        API referenceIntegral and Sum.

        -class sympy.concrete.expr_with_limits.ExprWithLimits(function, *symbols, **assumptions)[source]
        +class sympy.concrete.expr_with_limits.ExprWithLimits(function, *symbols, **assumptions)[source]
        property bound_symbols
        @@ -2987,7 +2987,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_legendre(n, n_digits)[source]
        +sympy.integrals.quadrature.gauss_legendre(n, n_digits)[source]

        Computes the Gauss-Legendre quadrature [R578] points and weights.

        Parameters:
        @@ -3054,7 +3054,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_laguerre(n, n_digits)[source]
        +sympy.integrals.quadrature.gauss_laguerre(n, n_digits)[source]

        Computes the Gauss-Laguerre quadrature [R580] points and weights.

        Parameters:
        @@ -3121,7 +3121,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_hermite(n, n_digits)[source]
        +sympy.integrals.quadrature.gauss_hermite(n, n_digits)[source]

        Computes the Gauss-Hermite quadrature [R582] points and weights.

        Parameters:
        @@ -3195,7 +3195,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_gen_laguerre(n, alpha, n_digits)[source]
        +sympy.integrals.quadrature.gauss_gen_laguerre(n, alpha, n_digits)[source]

        Computes the generalized Gauss-Laguerre quadrature [R585] points and weights.

        Parameters:
        @@ -3271,7 +3271,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_chebyshev_t(n, n_digits)[source]
        +sympy.integrals.quadrature.gauss_chebyshev_t(n, n_digits)[source]

        Computes the Gauss-Chebyshev quadrature [R587] points and weights of the first kind.

        @@ -3342,7 +3342,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_chebyshev_u(n, n_digits)[source]
        +sympy.integrals.quadrature.gauss_chebyshev_u(n, n_digits)[source]

        Computes the Gauss-Chebyshev quadrature [R589] points and weights of the second kind.

        @@ -3407,7 +3407,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_jacobi(n, alpha, beta, n_digits)[source]
        +sympy.integrals.quadrature.gauss_jacobi(n, alpha, beta, n_digits)[source]

        Computes the Gauss-Jacobi quadrature [R591] points and weights.

        Parameters:
        @@ -3482,7 +3482,7 @@

        Numeric Integrals
        -sympy.integrals.quadrature.gauss_lobatto(n, n_digits)[source]
        +sympy.integrals.quadrature.gauss_lobatto(n, n_digits)[source]

        Computes the Gauss-Lobatto quadrature [R594] points and weights.

        Parameters:
        @@ -3648,7 +3648,7 @@

        API referencemax_degree=None,

        -)[source] +)[source]

        Integrates polynomials over 2/3-Polytopes.

        Parameters:
        diff --git a/dev/modules/interactive.html b/dev/modules/interactive.html index a3bd5f63ec1..0ead61db7a1 100644 --- a/dev/modules/interactive.html +++ b/dev/modules/interactive.html @@ -809,13 +809,13 @@
        Documentation Version

        Tools for setting up interactive sessions.

        -sympy.interactive.session.enable_automatic_int_sympification(shell)[source]
        +sympy.interactive.session.enable_automatic_int_sympification(shell)[source]

        Allow IPython to automatically convert integer literals to Integer.

        -sympy.interactive.session.enable_automatic_symbols(shell)[source]
        +sympy.interactive.session.enable_automatic_symbols(shell)[source]

        Allow IPython to automatically create symbols (isympy -a).

        @@ -830,13 +830,13 @@
        Documentation Version
        auto_int_to_Integer=False,
        -)[source] +)[source]

        Construct new IPython session.

        -sympy.interactive.session.init_python_session()[source]
        +sympy.interactive.session.init_python_session()[source]

        Construct new Python session.

        @@ -859,7 +859,7 @@
        Documentation Version
        argv=[],

        -)[source] +)[source]

        Initialize an embedded IPython or Python session. The IPython session is initiated with the –pylab option, without the numpy imports, so that matplotlib plotting can be interactive.

        @@ -977,7 +977,7 @@
        Documentation Version
        -sympy.interactive.session.int_to_Integer(s)[source]
        +sympy.interactive.session.int_to_Integer(s)[source]

        Wrap integer literals with Integer.

        This is based on the decistmt example from https://docs.python.org/3/library/tokenize.html.

        @@ -1029,7 +1029,7 @@
        Documentation Version
        **settings,
        -)[source] +)[source]

        Initializes pretty-printer depending on the environment.

        Parameters:
        diff --git a/dev/modules/liealgebras/index.html b/dev/modules/liealgebras/index.html index 5ae13c3ef93..3d185bc9820 100644 --- a/dev/modules/liealgebras/index.html +++ b/dev/modules/liealgebras/index.html @@ -805,7 +805,7 @@
        Documentation Version

        Lie Algebra

        -class sympy.liealgebras.root_system.RootSystem(cartantype)[source]
        +class sympy.liealgebras.root_system.RootSystem(cartantype)[source]

        Represent the root system of a simple Lie algebra

        Every simple Lie algebra has a unique root system. To find the root system, we first consider the Cartan subalgebra of g, which is the maximal @@ -840,7 +840,7 @@

        Documentation Version

        -add_as_roots(root1, root2)[source]
        +add_as_roots(root1, root2)[source]

        Add two roots together if and only if their sum is also a root

        It takes as input two vectors which should be roots. It then computes their sum and checks if it is in the list of all possible roots. If it @@ -859,7 +859,7 @@

        Documentation Version
        -add_simple_roots(root1, root2)[source]
        +add_simple_roots(root1, root2)[source]

        Add two simple roots together

        The function takes as input two integers, root1 and root2. It then uses these integers as keys in the dictionary of simple roots, and gets @@ -876,7 +876,7 @@

        Documentation Version
        -all_roots()[source]
        +all_roots()[source]

        Generate all the roots of a given root system

        The result is a dictionary where the keys are integer numbers. It generates the roots by getting the dictionary of all positive roots @@ -887,7 +887,7 @@

        Documentation Version
        -cartan_matrix()[source]
        +cartan_matrix()[source]

        Cartan matrix of Lie algebra associated with this root system

        Examples

        >>> from sympy.liealgebras.root_system import RootSystem
        @@ -903,7 +903,7 @@ 
        Documentation Version
        -dynkin_diagram()[source]
        +dynkin_diagram()[source]

        Dynkin diagram of the Lie algebra associated with this root system

        Examples

        >>> from sympy.liealgebras.root_system import RootSystem
        @@ -917,7 +917,7 @@ 
        Documentation Version
        -root_space()[source]
        +root_space()[source]

        Return the span of the simple roots

        The root space is the vector space spanned by the simple roots, i.e. it is a vector space with a distinguished basis, the simple roots. This @@ -934,7 +934,7 @@

        Documentation Version
        -simple_roots()[source]
        +simple_roots()[source]

        Generate the simple roots of the Lie algebra

        The rank of the Lie algebra determines the number of simple roots that it has. This method obtains the rank of the Lie algebra, and then uses @@ -954,13 +954,13 @@

        Documentation Version
        -class sympy.liealgebras.type_a.TypeA(n)[source]
        +class sympy.liealgebras.type_a.TypeA(n)[source]

        This class contains the information about the A series of simple Lie algebras. ====

        -basic_root(i, j)[source]
        +basic_root(i, j)[source]

        This is a method just to generate roots with a 1 iin the ith position and a -1 in the jth position.

        @@ -968,13 +968,13 @@
        Documentation Version
        -basis()[source]
        +basis()[source]

        Returns the number of independent generators of A_n

        -cartan_matrix()[source]
        +cartan_matrix()[source]

        Returns the Cartan matrix for A_n. The Cartan matrix matrix for a Lie algebra is generated by assigning an ordering to the simple @@ -995,7 +995,7 @@

        Documentation Version
        -dimension()[source]
        +dimension()[source]

        Dimension of the vector space V underlying the Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_type import CartanType
        @@ -1008,19 +1008,19 @@ 
        Documentation Version
        -highest_root()[source]
        +highest_root()[source]

        Returns the highest weight root for A_n

        -lie_algebra()[source]
        +lie_algebra()[source]

        Returns the Lie algebra associated with A_n

        -positive_roots()[source]
        +positive_roots()[source]

        This method generates all the positive roots of A_n. This is half of all of the roots of A_n; by multiplying all the positive roots by -1 we @@ -1037,13 +1037,13 @@

        Documentation Version
        -roots()[source]
        +roots()[source]

        Returns the total number of roots for A_n

        -simple_root(i)[source]
        +simple_root(i)[source]

        Every lie algebra has a unique root system. Given a root system Q, there is a subset of the roots such that an element of Q is called a @@ -1069,10 +1069,10 @@

        Documentation Version
        -class sympy.liealgebras.type_b.TypeB(n)[source]
        +class sympy.liealgebras.type_b.TypeB(n)[source]
        -basic_root(i, j)[source]
        +basic_root(i, j)[source]

        This is a method just to generate roots with a 1 iin the ith position and a -1 in the jth position.

        @@ -1080,13 +1080,13 @@
        Documentation Version
        -basis()[source]
        +basis()[source]

        Returns the number of independent generators of B_n

        -cartan_matrix()[source]
        +cartan_matrix()[source]

        Returns the Cartan matrix for B_n. The Cartan matrix matrix for a Lie algebra is generated by assigning an ordering to the simple @@ -1107,7 +1107,7 @@

        Documentation Version
        -dimension()[source]
        +dimension()[source]

        Dimension of the vector space V underlying the Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_type import CartanType
        @@ -1120,13 +1120,13 @@ 
        Documentation Version
        -lie_algebra()[source]
        +lie_algebra()[source]

        Returns the Lie algebra associated with B_n

        -positive_roots()[source]
        +positive_roots()[source]

        This method generates all the positive roots of A_n. This is half of all of the roots of B_n; by multiplying all the positive roots by -1 we @@ -1143,13 +1143,13 @@

        Documentation Version
        -roots()[source]
        +roots()[source]

        Returns the total number of roots for B_n”

        -simple_root(i)[source]
        +simple_root(i)[source]

        Every lie algebra has a unique root system. Given a root system Q, there is a subset of the roots such that an element of Q is called a @@ -1177,22 +1177,22 @@

        Documentation Version
        -class sympy.liealgebras.type_c.TypeC(n)[source]
        +class sympy.liealgebras.type_c.TypeC(n)[source]
        -basic_root(i, j)[source]
        +basic_root(i, j)[source]

        Generate roots with 1 in ith position and a -1 in jth position

        -basis()[source]
        +basis()[source]

        Returns the number of independent generators of C_n

        -cartan_matrix()[source]
        +cartan_matrix()[source]

        The Cartan matrix for C_n

        The Cartan matrix matrix for a Lie algebra is generated by assigning an ordering to the simple @@ -1213,7 +1213,7 @@

        Documentation Version
        -dimension()[source]
        +dimension()[source]

        Dimension of the vector space V underlying the Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_type import CartanType
        @@ -1226,13 +1226,13 @@ 
        Documentation Version
        -lie_algebra()[source]
        +lie_algebra()[source]

        Returns the Lie algebra associated with C_n”

        -positive_roots()[source]
        +positive_roots()[source]

        Generates all the positive roots of A_n

        This is half of all of the roots of C_n; by multiplying all the positive roots by -1 we get the negative roots.

        @@ -1248,13 +1248,13 @@
        Documentation Version
        -roots()[source]
        +roots()[source]

        Returns the total number of roots for C_n”

        -simple_root(i)[source]
        +simple_root(i)[source]

        The ith simple root for the C series

        Every lie algebra has a unique root system. Given a root system Q, there is a subset of the @@ -1282,10 +1282,10 @@

        Documentation Version
        -class sympy.liealgebras.type_d.TypeD(n)[source]
        +class sympy.liealgebras.type_d.TypeD(n)[source]
        -basic_root(i, j)[source]
        +basic_root(i, j)[source]

        This is a method just to generate roots with a 1 iin the ith position and a -1 in the jth position.

        @@ -1293,13 +1293,13 @@
        Documentation Version
        -basis()[source]
        +basis()[source]

        Returns the number of independent generators of D_n

        -cartan_matrix()[source]
        +cartan_matrix()[source]

        Returns the Cartan matrix for D_n. The Cartan matrix matrix for a Lie algebra is generated by assigning an ordering to the simple @@ -1320,7 +1320,7 @@

        Documentation Version
        -dimension()[source]
        +dimension()[source]

        Dmension of the vector space V underlying the Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_type import CartanType
        @@ -1333,13 +1333,13 @@ 
        Documentation Version
        -lie_algebra()[source]
        +lie_algebra()[source]

        Returns the Lie algebra associated with D_n”

        -positive_roots()[source]
        +positive_roots()[source]

        This method generates all the positive roots of A_n. This is half of all of the roots of D_n by multiplying all the positive roots by -1 we @@ -1356,13 +1356,13 @@

        Documentation Version
        -roots()[source]
        +roots()[source]

        Returns the total number of roots for D_n”

        -simple_root(i)[source]
        +simple_root(i)[source]

        Every lie algebra has a unique root system. Given a root system Q, there is a subset of the roots such that an element of Q is called a @@ -1390,10 +1390,10 @@

        Documentation Version
        -class sympy.liealgebras.type_e.TypeE(n)[source]
        +class sympy.liealgebras.type_e.TypeE(n)[source]
        -basic_root(i, j)[source]
        +basic_root(i, j)[source]

        This is a method just to generate roots with a -1 in the ith position and a 1 in the jth position.

        @@ -1401,13 +1401,13 @@
        Documentation Version
        -basis()[source]
        +basis()[source]

        Returns the number of independent generators of E_n

        -cartan_matrix()[source]
        +cartan_matrix()[source]

        Returns the Cartan matrix for G_2 The Cartan matrix matrix for a Lie algebra is generated by assigning an ordering to the simple @@ -1428,7 +1428,7 @@

        Documentation Version
        -dimension()[source]
        +dimension()[source]

        Dimension of the vector space V underlying the Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_type import CartanType
        @@ -1441,7 +1441,7 @@ 
        Documentation Version
        -positive_roots()[source]
        +positive_roots()[source]

        This method generates all the positive roots of A_n. This is half of all of the roots of E_n; by multiplying all the positive roots by -1 we @@ -1458,13 +1458,13 @@

        Documentation Version
        -roots()[source]
        +roots()[source]

        Returns the total number of roots of E_n

        -simple_root(i)[source]
        +simple_root(i)[source]

        Every Lie algebra has a unique root system. Given a root system Q, there is a subset of the roots such that an element of Q is called a @@ -1487,22 +1487,22 @@

        Documentation Version
        -class sympy.liealgebras.type_f.TypeF(n)[source]
        +class sympy.liealgebras.type_f.TypeF(n)[source]
        -basic_root(i, j)[source]
        +basic_root(i, j)[source]

        Generate roots with 1 in ith position and -1 in jth position

        -basis()[source]
        +basis()[source]

        Returns the number of independent generators of F_4

        -cartan_matrix()[source]
        +cartan_matrix()[source]

        The Cartan matrix for F_4

        The Cartan matrix matrix for a Lie algebra is generated by assigning an ordering to the simple @@ -1523,7 +1523,7 @@

        Documentation Version
        -dimension()[source]
        +dimension()[source]

        Dimension of the vector space V underlying the Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_type import CartanType
        @@ -1536,7 +1536,7 @@ 
        Documentation Version
        -positive_roots()[source]
        +positive_roots()[source]

        Generate all the positive roots of A_n

        This is half of all of the roots of F_4; by multiplying all the positive roots by -1 we get the negative roots.

        @@ -1552,13 +1552,13 @@
        Documentation Version
        -roots()[source]
        +roots()[source]

        Returns the total number of roots for F_4

        -simple_root(i)[source]
        +simple_root(i)[source]

        The ith simple root of F_4

        Every lie algebra has a unique root system. Given a root system Q, there is a subset of the @@ -1581,16 +1581,16 @@

        Documentation Version
        -class sympy.liealgebras.type_g.TypeG(n)[source]
        +class sympy.liealgebras.type_g.TypeG(n)[source]
        -basis()[source]
        +basis()[source]

        Returns the number of independent generators of G_2

        -cartan_matrix()[source]
        +cartan_matrix()[source]

        The Cartan matrix for G_2

        The Cartan matrix matrix for a Lie algebra is generated by assigning an ordering to the simple @@ -1609,7 +1609,7 @@

        Documentation Version
        -dimension()[source]
        +dimension()[source]

        Dimension of the vector space V underlying the Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_type import CartanType
        @@ -1622,7 +1622,7 @@ 
        Documentation Version
        -positive_roots()[source]
        +positive_roots()[source]

        Generate all the positive roots of A_n

        This is half of all of the roots of A_n; by multiplying all the positive roots by -1 we get the negative roots.

        @@ -1638,13 +1638,13 @@
        Documentation Version
        -roots()[source]
        +roots()[source]

        Returns the total number of roots of G_2”

        -simple_root(i)[source]
        +simple_root(i)[source]

        The ith simple root of G_2

        Every lie algebra has a unique root system. Given a root system Q, there is a subset of the @@ -1667,7 +1667,7 @@

        Documentation Version
        -class sympy.liealgebras.weyl_group.WeylGroup(cartantype)[source]
        +class sympy.liealgebras.weyl_group.WeylGroup(cartantype)[source]

        For each semisimple Lie group, we have a Weyl group. It is a subgroup of the isometry group of the root system. Specifically, it’s the subgroup that is generated by reflections through the hyperplanes orthogonal to @@ -1675,7 +1675,7 @@

        Documentation Version
        group is a finite Coxeter group.

        -coxeter_diagram()[source]
        +coxeter_diagram()[source]

        This method returns the Coxeter diagram corresponding to a Weyl group. The Coxeter diagram can be obtained from a Lie algebra’s Dynkin diagram by deleting all arrows; the Coxeter diagram is the undirected graph. @@ -1696,7 +1696,7 @@

        Documentation Version
        -delete_doubles(reflections)[source]
        +delete_doubles(reflections)[source]

        This is a helper method for determining the order of an element in the Weyl group of G2. It takes a Weyl element and if repeated simple reflections in it, it deletes them.

        @@ -1704,7 +1704,7 @@
        Documentation Version
        -element_order(weylelt)[source]
        +element_order(weylelt)[source]

        This method returns the order of a given Weyl group element, which should be specified by the user in the form of products of the generating reflections, i.e. of the form r1*r2 etc.

        @@ -1722,7 +1722,7 @@
        Documentation Version
        -generators()[source]
        +generators()[source]

        This method creates the generating reflections of the Weyl group for a given Lie algebra. For a Lie algebra of rank n, there are n different generating reflections. This function returns them as @@ -1738,7 +1738,7 @@

        Documentation Version
        -group_name()[source]
        +group_name()[source]

        This method returns some general information about the Weyl group for a given Lie algebra. It returns the name of the group and the elements it acts on, if relevant.

        @@ -1746,7 +1746,7 @@
        Documentation Version
        -group_order()[source]
        +group_order()[source]

        This method returns the order of the Weyl group. For types A, B, C, D, and E the order depends on the rank of the Lie algebra. For types F and G, @@ -1762,7 +1762,7 @@

        Documentation Version
        -matrix_form(weylelt)[source]
        +matrix_form(weylelt)[source]

        This method takes input from the user in the form of products of the generating reflections, and returns the matrix corresponding to the element of the Weyl group. Since each element of the Weyl group is @@ -1786,23 +1786,23 @@

        Documentation Version
        -class sympy.liealgebras.cartan_type.CartanType_generator[source]
        +class sympy.liealgebras.cartan_type.CartanType_generator[source]

        Constructor for actually creating things

        -class sympy.liealgebras.cartan_type.Standard_Cartan(series, n)[source]
        +class sympy.liealgebras.cartan_type.Standard_Cartan(series, n)[source]

        Concrete base class for Cartan types such as A4, etc

        -rank()[source]
        +rank()[source]

        Returns the rank of the Lie algebra

        -series()[source]
        +series()[source]

        Returns the type of the Lie algebra

        @@ -1810,7 +1810,7 @@
        Documentation Version
        -sympy.liealgebras.dynkin_diagram.DynkinDiagram(t)[source]
        +sympy.liealgebras.dynkin_diagram.DynkinDiagram(t)[source]

        Display the Dynkin diagram of a given Lie algebra

        Works by generating the CartanType for the input, t, and then returning the Dynkin diagram method from the individual classes.

        @@ -1830,7 +1830,7 @@
        Documentation Version
        -sympy.liealgebras.cartan_matrix.CartanMatrix(ct)[source]
        +sympy.liealgebras.cartan_matrix.CartanMatrix(ct)[source]

        Access the Cartan matrix of a specific Lie algebra

        Examples

        >>> from sympy.liealgebras.cartan_matrix import CartanMatrix
        diff --git a/dev/modules/logic.html b/dev/modules/logic.html
        index b5476c24a9d..e91125f9695 100644
        --- a/dev/modules/logic.html
        +++ b/dev/modules/logic.html
        @@ -840,7 +840,7 @@ 

        Forming logical expressions
        -sympy.logic.boolalg.SOPform(variables, minterms, dontcares=None)[source]
        +sympy.logic.boolalg.SOPform(variables, minterms, dontcares=None)[source]

        The SOPform function uses simplified_pairs and a redundant group- eliminating algorithm to convert the list of all input combos that generate ‘1’ (the minterms) into the smallest sum-of-products form.

        @@ -901,7 +901,7 @@

        Forming logical expressions
        -sympy.logic.boolalg.POSform(variables, minterms, dontcares=None)[source]
        +sympy.logic.boolalg.POSform(variables, minterms, dontcares=None)[source]

        The POSform function uses simplified_pairs and a redundant-group eliminating algorithm to convert the list of all input combinations that generate ‘1’ (the minterms) into the smallest product-of-sums form.

        @@ -962,7 +962,7 @@

        Forming logical expressions
        -sympy.logic.boolalg.ANFform(variables, truthvalues)[source]
        +sympy.logic.boolalg.ANFform(variables, truthvalues)[source]

        The ANFform function converts the list of truth values to Algebraic Normal Form (ANF).

        The variables must be given as the first argument.

        @@ -1006,11 +1006,11 @@

        Forming logical expressions

        -class sympy.logic.boolalg.Boolean(*args)[source]
        +class sympy.logic.boolalg.Boolean(*args)[source]

        A Boolean object is an object for which logic operations make sense.

        -as_set()[source]
        +as_set()[source]

        Rewrites Boolean expression in terms of real sets.

        Examples

        >>> from sympy import Symbol, Eq, Or, And
        @@ -1029,7 +1029,7 @@ 

        Boolean functions
        -equals(other)[source]
        +equals(other)[source]

        Returns True if the given formulas have the same truth table. For two formulas to be equal they must have the same literals.

        Examples

        @@ -1049,7 +1049,7 @@

        Boolean functions
        -class sympy.logic.boolalg.BooleanTrue[source]
        +class sympy.logic.boolalg.BooleanTrue[source]

        SymPy version of True, a singleton that can be accessed via S.true.

        This is the SymPy version of True, for use in the logic module. The primary advantage of using true instead of True is that shorthand Boolean @@ -1122,7 +1122,7 @@

        Boolean functions
        -as_set()[source]
        +as_set()[source]

        Rewrite logic operators and relationals in terms of real sets.

        Examples

        >>> from sympy import true
        @@ -1136,7 +1136,7 @@ 

        Boolean functions
        -class sympy.logic.boolalg.BooleanFalse[source]
        +class sympy.logic.boolalg.BooleanFalse[source]

        SymPy version of False, a singleton that can be accessed via S.false.

        This is the SymPy version of False, for use in the logic module. The primary advantage of using false instead of False is that shorthand @@ -1173,7 +1173,7 @@

        Boolean functions
        -as_set()[source]
        +as_set()[source]

        Rewrite logic operators and relationals in terms of real sets.

        Examples

        >>> from sympy import false
        @@ -1187,7 +1187,7 @@ 

        Boolean functions
        -class sympy.logic.boolalg.And(*args)[source]
        +class sympy.logic.boolalg.And(*args)[source]

        Logical AND function.

        It evaluates its arguments in order, returning false immediately when an argument is false and true if they are all true.

        @@ -1211,7 +1211,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Or(*args)[source]
        +class sympy.logic.boolalg.Or(*args)[source]

        Logical OR function

        It evaluates its arguments in order, returning true immediately when an argument is true, and false if they are all false.

        @@ -1235,7 +1235,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Not(arg)[source]
        +class sympy.logic.boolalg.Not(arg)[source]

        Logical Not function (negation)

        Returns true if the statement is false or False. Returns false if the statement is true or True.

        @@ -1281,7 +1281,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Xor(*args)[source]
        +class sympy.logic.boolalg.Xor(*args)[source]

        Logical XOR (exclusive OR) function.

        Returns True if an odd number of the arguments are True and the rest are False.

        @@ -1316,7 +1316,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Nand(*args)[source]
        +class sympy.logic.boolalg.Nand(*args)[source]

        Logical NAND function.

        It evaluates its arguments in order, giving True immediately if any of them are False, and False if they are all True.

        @@ -1338,7 +1338,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Nor(*args)[source]
        +class sympy.logic.boolalg.Nor(*args)[source]

        Logical NOR function.

        It evaluates its arguments in order, giving False immediately if any of them are True, and True if they are all False.

        @@ -1366,7 +1366,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Xnor(*args)[source]
        +class sympy.logic.boolalg.Xnor(*args)[source]

        Logical XNOR function.

        Returns False if an odd number of the arguments are True and the rest are False.

        @@ -1390,7 +1390,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Implies(*args)[source]
        +class sympy.logic.boolalg.Implies(*args)[source]

        Logical implication.

        A implies B is equivalent to if A then B. Mathematically, it is written as \(A \Rightarrow B\) and is equivalent to \(\neg A \vee B\) or ~A | B.

        @@ -1436,7 +1436,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Equivalent(*args)[source]
        +class sympy.logic.boolalg.Equivalent(*args)[source]

        Equivalence relation.

        Equivalent(A, B) is True iff A and B are both True or both False.

        Returns True if all of the arguments are logically equivalent. @@ -1457,7 +1457,7 @@

        Boolean functions
        -class sympy.logic.boolalg.ITE(*args)[source]
        +class sympy.logic.boolalg.ITE(*args)[source]

        If-then-else clause.

        ITE(A, B, C) evaluates and returns the result of B if A is true else it returns the result of C. All args must be Booleans.

        @@ -1491,7 +1491,7 @@

        Boolean functions
        -class sympy.logic.boolalg.Exclusive(*args)[source]
        +class sympy.logic.boolalg.Exclusive(*args)[source]

        True if only one or no argument is true.

        Exclusive(A, B, C) is equivalent to ~(A & B) & ~(A & C) & ~(B & C).

        For two arguments, this is equivalent to Xor.

        @@ -1511,7 +1511,7 @@

        Boolean functions
        -sympy.logic.boolalg.to_anf(expr, deep=True)[source]
        +sympy.logic.boolalg.to_anf(expr, deep=True)[source]

        Converts expr to Algebraic Normal Form (ANF).

        ANF is a canonical normal form, which means that two equivalent formulas will convert to the same ANF.

        @@ -1550,7 +1550,7 @@

        Boolean functions
        -sympy.logic.boolalg.to_cnf(expr, simplify=False, force=False)[source]
        +sympy.logic.boolalg.to_cnf(expr, simplify=False, force=False)[source]

        Convert a propositional logical sentence expr to conjunctive normal form: ((A | ~B | ...) & (B | C | ...) & ...). If simplify is True, expr is evaluated to its simplest CNF @@ -1570,7 +1570,7 @@

        Boolean functions
        -sympy.logic.boolalg.to_dnf(expr, simplify=False, force=False)[source]
        +sympy.logic.boolalg.to_dnf(expr, simplify=False, force=False)[source]

        Convert a propositional logical sentence expr to disjunctive normal form: ((A & ~B & ...) | (B & C & ...) | ...). If simplify is True, expr is evaluated to its simplest DNF form using @@ -1590,7 +1590,7 @@

        Boolean functions
        -sympy.logic.boolalg.to_nnf(expr, simplify=True)[source]
        +sympy.logic.boolalg.to_nnf(expr, simplify=True)[source]

        Converts expr to Negation Normal Form (NNF).

        A logical expression is in NNF if it contains only And, Or and Not, @@ -1609,7 +1609,7 @@

        Boolean functions
        -sympy.logic.boolalg.is_anf(expr)[source]
        +sympy.logic.boolalg.is_anf(expr)[source]

        Checks if expr is in Algebraic Normal Form (ANF).

        A logical expression is in ANF if it has the form

        @@ -1637,7 +1637,7 @@

        Boolean functions
        -sympy.logic.boolalg.is_cnf(expr)[source]
        +sympy.logic.boolalg.is_cnf(expr)[source]

        Test whether or not an expression is in conjunctive normal form.

        Examples

        >>> from sympy.logic.boolalg import is_cnf
        @@ -1654,7 +1654,7 @@ 

        Boolean functions
        -sympy.logic.boolalg.is_dnf(expr)[source]
        +sympy.logic.boolalg.is_dnf(expr)[source]

        Test whether or not an expression is in disjunctive normal form.

        Examples

        >>> from sympy.logic.boolalg import is_dnf
        @@ -1673,7 +1673,7 @@ 

        Boolean functions
        -sympy.logic.boolalg.is_nnf(expr, simplified=True)[source]
        +sympy.logic.boolalg.is_nnf(expr, simplified=True)[source]

        Checks if expr is in Negation Normal Form (NNF).

        A logical expression is in NNF if it contains only And, Or and Not, @@ -1698,7 +1698,7 @@

        Boolean functions
        -sympy.logic.boolalg.gateinputcount(expr)[source]
        +sympy.logic.boolalg.gateinputcount(expr)[source]

        Return the total number of inputs for the logic gates realizing the Boolean expression.

        @@ -1762,7 +1762,7 @@

        Simplification and equivalence-testingdontcare=None,

        -)[source] +)[source]

        This function simplifies a boolean function to its simplified version in SOP or POS form. The return type is an Or or And object in SymPy.

        @@ -1823,7 +1823,7 @@

        Simplification and equivalence-testing
        -sympy.logic.boolalg.bool_map(bool1, bool2)[source]
        +sympy.logic.boolalg.bool_map(bool1, bool2)[source]

        Return the simplified version of bool1, and the mapping of variables that makes the two expressions bool1 and bool2 represent the same logical behaviour for some correspondence between the variables @@ -1861,7 +1861,7 @@

        Manipulating expressions
        -sympy.logic.boolalg.distribute_and_over_or(expr)[source]
        +sympy.logic.boolalg.distribute_and_over_or(expr)[source]

        Given a sentence expr consisting of conjunctions and disjunctions of literals, return an equivalent sentence in CNF.

        Examples

        @@ -1875,7 +1875,7 @@

        Manipulating expressions
        -sympy.logic.boolalg.distribute_or_over_and(expr)[source]
        +sympy.logic.boolalg.distribute_or_over_and(expr)[source]

        Given a sentence expr consisting of conjunctions and disjunctions of literals, return an equivalent sentence in DNF.

        Note that the output is NOT simplified.

        @@ -1890,7 +1890,7 @@

        Manipulating expressions
        -sympy.logic.boolalg.distribute_xor_over_and(expr)[source]
        +sympy.logic.boolalg.distribute_xor_over_and(expr)[source]

        Given a sentence expr consisting of conjunction and exclusive disjunctions of literals, return an equivalent exclusive disjunction.

        @@ -1906,7 +1906,7 @@

        Manipulating expressions
        -sympy.logic.boolalg.eliminate_implications(expr)[source]
        +sympy.logic.boolalg.eliminate_implications(expr)[source]

        Change Implies and Equivalent into And, Or, and Not. That is, return an expression that is equivalent to expr, but has only @@ -1931,7 +1931,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.truth_table(expr, variables, input=True)[source]
        +sympy.logic.boolalg.truth_table(expr, variables, input=True)[source]

        Return a generator of all possible configurations of the input variables, and the result of the boolean expression for those values.

        @@ -1987,7 +1987,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.integer_to_term(n, bits=None, str=False)[source]
        +sympy.logic.boolalg.integer_to_term(n, bits=None, str=False)[source]

        Return a list of length bits corresponding to the binary value of n with small bits to the right (last). If bits is omitted, the length will be the number required to represent n. If the bits are @@ -2030,7 +2030,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.term_to_integer(term)[source]
        +sympy.logic.boolalg.term_to_integer(term)[source]

        Return an integer corresponding to the base-2 digits given by term.

        Parameters:
        @@ -2049,7 +2049,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.bool_maxterm(k, variables)[source]
        +sympy.logic.boolalg.bool_maxterm(k, variables)[source]

        Return the k-th maxterm.

        Each maxterm is assigned an index based on the opposite conventional binary encoding used for minterms. The maxterm @@ -2081,7 +2081,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.bool_minterm(k, variables)[source]
        +sympy.logic.boolalg.bool_minterm(k, variables)[source]

        Return the k-th minterm.

        Minterms are numbered by a binary encoding of the complementation pattern of the variables. This convention assigns the value 1 to @@ -2112,7 +2112,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.bool_monomial(k, variables)[source]
        +sympy.logic.boolalg.bool_monomial(k, variables)[source]

        Return the k-th monomial.

        Monomials are numbered by a binary encoding of the presence and absences of the variables. This convention assigns the value @@ -2145,7 +2145,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.anf_coeffs(truthvalues)[source]
        +sympy.logic.boolalg.anf_coeffs(truthvalues)[source]

        Convert a list of truth values of some boolean expression to the list of coefficients of the polynomial mod 2 (exclusive disjunction) representing the boolean expression in ANF @@ -2178,7 +2178,7 @@

        Truth tables and related functions
        -sympy.logic.boolalg.to_int_repr(clauses, symbols)[source]
        +sympy.logic.boolalg.to_int_repr(clauses, symbols)[source]

        Takes clauses in CNF format and puts them into an integer representation.

        Examples

        >>> from sympy.logic.boolalg import to_int_repr
        @@ -2223,7 +2223,7 @@ 

        Truth tables and related functionsuse_lra_theory=False,

        -)[source] +)[source]

        Check satisfiability of a propositional sentence. Returns a model when it succeeds. Returns {true: true} for trivially true expressions.

        diff --git a/dev/modules/matrices/dense.html b/dev/modules/matrices/dense.html index 76aacea095a..f3264715525 100644 --- a/dev/modules/matrices/dense.html +++ b/dev/modules/matrices/dense.html @@ -805,17 +805,17 @@
        Documentation Version

        Dense Matrices

        -sympy.matrices.dense.Matrix[source]
        +sympy.matrices.dense.Matrix[source]

        alias of MutableDenseMatrix

        -class sympy.matrices.dense.DenseMatrix[source]
        +class sympy.matrices.dense.DenseMatrix[source]

        Matrix implementation based on DomainMatrix as the internal representation

        -LDLdecomposition(hermitian=True)[source]
        +LDLdecomposition(hermitian=True)[source]

        Returns the LDL Decomposition (L, D) of matrix A, such that L * D * L.H == A if hermitian flag is True, or L * D * L.T == A if hermitian is False. @@ -865,13 +865,13 @@

        Dense Matrices
        -as_immutable()[source]
        +as_immutable()[source]

        Returns an Immutable version of this Matrix

        -as_mutable()[source]
        +as_mutable()[source]

        Returns a mutable version of this matrix

        Examples

        >>> from sympy import ImmutableMatrix
        @@ -888,7 +888,7 @@ 

        Dense Matrices
        -cholesky(hermitian=True)[source]
        +cholesky(hermitian=True)[source]

        Returns the Cholesky-type decomposition L of a matrix A such that L * L.H == A if hermitian flag is True, or L * L.T == A if hermitian is False.

        @@ -942,7 +942,7 @@

        Dense Matrices
        -lower_triangular_solve(rhs)[source]
        +lower_triangular_solve(rhs)[source]

        Solves Ax = B, where A is a lower triangular matrix.

        See also

        @@ -952,7 +952,7 @@

        Dense Matrices
        -upper_triangular_solve(rhs)[source]
        +upper_triangular_solve(rhs)[source]

        Solves Ax = B, where A is an upper triangular matrix.

        See also

        @@ -964,10 +964,10 @@

        Dense Matrices
        -class sympy.matrices.dense.MutableDenseMatrix(*args, **kwargs)[source]
        +class sympy.matrices.dense.MutableDenseMatrix(*args, **kwargs)[source]
        -simplify(**kwargs)[source]
        +simplify(**kwargs)[source]

        Applies simplify to the elements of a matrix in place.

        This is a shortcut for M.applyfunc(lambda x: simplify(x, ratio, measure))

        @@ -980,7 +980,7 @@

        Dense Matrices
        -class sympy.matrices.immutable.ImmutableDenseMatrix(*args, **kwargs)[source]
        +class sympy.matrices.immutable.ImmutableDenseMatrix(*args, **kwargs)[source]

        Create an immutable version of a matrix.

        Examples

        >>> from sympy import eye, ImmutableMatrix
        diff --git a/dev/modules/matrices/expressions.html b/dev/modules/matrices/expressions.html
        index c70708ef1ee..5a15b06caad 100644
        --- a/dev/modules/matrices/expressions.html
        +++ b/dev/modules/matrices/expressions.html
        @@ -842,7 +842,7 @@ 
        Documentation Version

        Matrix Expressions Core Reference

        -class sympy.matrices.expressions.MatrixExpr(*args, **kwargs)[source]
        +class sympy.matrices.expressions.MatrixExpr(*args, **kwargs)[source]

        Superclass for Matrix Expressions

        MatrixExprs represent abstract matrices, linear transformations represented within a particular basis.

        @@ -865,13 +865,13 @@

        Matrix Expressions Core Reference
        -as_coeff_Mul(rational=False)[source]
        +as_coeff_Mul(rational=False)[source]

        Efficiently extract the coefficient of a product.

        -as_explicit()[source]
        +as_explicit()[source]

        Returns a dense Matrix with elements represented explicitly

        Returns an object of type ImmutableDenseMatrix.

        Examples

        @@ -897,7 +897,7 @@

        Matrix Expressions Core Reference
        -as_mutable()[source]
        +as_mutable()[source]

        Returns a dense, mutable matrix with elements represented explicitly

        Examples

        >>> from sympy import Identity
        @@ -924,7 +924,7 @@ 

        Matrix Expressions Core Reference
        -equals(other)[source]
        +equals(other)[source]

        Test elementwise equality between matrices, potentially of different types

        >>> from sympy import Identity, eye
        @@ -945,7 +945,7 @@ 

        Matrix Expressions Core Referencedimensions=None,

        -)[source] +)[source]

        Parse expression of matrices with explicitly summed indices into a matrix expression without indices, if possible.

        This transformation expressed in mathematical notation:

        @@ -986,7 +986,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.MatrixSymbol(name, n, m)[source]
        +class sympy.matrices.expressions.MatrixSymbol(name, n, m)[source]

        Symbolic representation of a Matrix object

        Creates a SymPy Symbol to represent a Matrix. This matrix has a shape and can be included in Matrix Expressions

        @@ -1013,7 +1013,7 @@

        Matrix Expressions Core Reference_sympify=True,

        -)[source] +)[source]

        A Sum of Matrix Expressions

        MatAdd inherits from and operates like SymPy Add

        Examples

        @@ -1038,7 +1038,7 @@

        Matrix Expressions Core Reference_sympify=True,

        -)[source] +)[source]

        A product of matrix expressions

        Examples

        >>> from sympy import MatMul, MatrixSymbol
        @@ -1053,12 +1053,12 @@ 

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.MatPow(base, exp, evaluate=False, **options)[source]
        +class sympy.matrices.expressions.MatPow(base, exp, evaluate=False, **options)[source]

        -sympy.matrices.expressions.hadamard_product(*matrices)[source]
        +sympy.matrices.expressions.hadamard_product(*matrices)[source]

        Return the elementwise (aka Hadamard) product of matrices.

        Examples

        >>> from sympy import hadamard_product, MatrixSymbol
        @@ -1076,7 +1076,7 @@ 

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.HadamardProduct(*args, evaluate=False, check=None)[source]
        +class sympy.matrices.expressions.HadamardProduct(*args, evaluate=False, check=None)[source]

        Elementwise product of matrix expressions

        Examples

        Hadamard product for matrix symbols:

        @@ -1095,7 +1095,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.HadamardPower(base, exp)[source]
        +class sympy.matrices.expressions.HadamardPower(base, exp)[source]

        Elementwise power of matrix expressions

        Parameters:
        @@ -1149,7 +1149,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.Inverse(mat, exp=-1)[source]
        +class sympy.matrices.expressions.Inverse(mat, exp=-1)[source]

        The multiplicative inverse of a matrix expression

        This is a symbolic object that simply stores its argument without evaluating it. To actually compute the inverse, use the .inverse() @@ -1172,7 +1172,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.Transpose(*args, **kwargs)[source]
        +class sympy.matrices.expressions.Transpose(*args, **kwargs)[source]

        The transpose of a matrix expression.

        This is a symbolic object that simply stores its argument without evaluating it. To actually compute the transpose, use the transpose() @@ -1195,7 +1195,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.Trace(mat)[source]
        +class sympy.matrices.expressions.Trace(mat)[source]

        Matrix Trace

        Represents the trace of a matrix expression.

        Examples

        @@ -1216,7 +1216,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.FunctionMatrix(rows, cols, lamda)[source]
        +class sympy.matrices.expressions.FunctionMatrix(rows, cols, lamda)[source]

        Represents a matrix using a function (Lambda) which gives outputs according to the coordinates of each matrix entries.

        @@ -1284,7 +1284,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.PermutationMatrix(perm)[source]
        +class sympy.matrices.expressions.PermutationMatrix(perm)[source]

        A Permutation Matrix

        Parameters:
        @@ -1335,7 +1335,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.MatrixPermute(mat, perm, axis=0)[source]
        +class sympy.matrices.expressions.MatrixPermute(mat, perm, axis=0)[source]

        Symbolic representation for permuting matrix rows or columns.

        Parameters:
        @@ -1388,7 +1388,7 @@

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.Identity(n)[source]
        +class sympy.matrices.expressions.Identity(n)[source]

        The Matrix Identity I - multiplicative identity

        Examples

        >>> from sympy import Identity, MatrixSymbol
        @@ -1402,7 +1402,7 @@ 

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.ZeroMatrix(m, n)[source]
        +class sympy.matrices.expressions.ZeroMatrix(m, n)[source]

        The Matrix Zero 0 - additive identity

        Examples

        >>> from sympy import MatrixSymbol, ZeroMatrix
        @@ -1418,7 +1418,7 @@ 

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.CompanionMatrix(poly)[source]
        +class sympy.matrices.expressions.CompanionMatrix(poly)[source]

        A symbolic companion matrix of a polynomial.

        Examples

        >>> from sympy import Poly, Symbol, symbols
        @@ -1435,7 +1435,7 @@ 

        Matrix Expressions Core Reference
        -class sympy.matrices.expressions.MatrixSet(n, m, set)[source]
        +class sympy.matrices.expressions.MatrixSet(n, m, set)[source]

        MatrixSet represents the set of matrices with shape = (n, m) over the given set.

        Examples

        @@ -1460,7 +1460,7 @@

        Block MatricesImmutableMatrix objects.

        -class sympy.matrices.expressions.blockmatrix.BlockMatrix(*args, **kwargs)[source]
        +class sympy.matrices.expressions.blockmatrix.BlockMatrix(*args, **kwargs)[source]

        A BlockMatrix is a Matrix comprised of other matrices.

        The submatrices are stored in a SymPy Matrix object but accessed as part of a Matrix Expression

        @@ -1519,7 +1519,7 @@

        Block Matrices
        -LDUdecomposition()[source]
        +LDUdecomposition()[source]

        Returns the Block LDU decomposition of a 2x2 Block Matrix

        @@ -1565,7 +1565,7 @@

        Block Matrices
        -LUdecomposition()[source]
        +LUdecomposition()[source]

        Returns the Block LU decomposition of a 2x2 Block Matrix

        @@ -1610,7 +1610,7 @@

        Block Matrices
        -UDLdecomposition()[source]
        +UDLdecomposition()[source]

        Returns the Block UDL decomposition of a 2x2 Block Matrix

        @@ -1656,7 +1656,7 @@

        Block Matrices
        -schur(mat='A', generalized=False)[source]
        +schur(mat='A', generalized=False)[source]

        Return the Schur Complement of the 2x2 BlockMatrix

        Parameters:
        @@ -1731,7 +1731,7 @@

        Block Matrices
        -transpose()[source]
        +transpose()[source]

        Return transpose of matrix.

        Examples

        >>> from sympy import MatrixSymbol, BlockMatrix, ZeroMatrix
        @@ -1756,7 +1756,7 @@ 

        Block Matrices
        -class sympy.matrices.expressions.blockmatrix.BlockDiagMatrix(*mats)[source]
        +class sympy.matrices.expressions.blockmatrix.BlockDiagMatrix(*mats)[source]

        A sparse matrix with block matrices along its diagonals

        Examples

        >>> from sympy import MatrixSymbol, BlockDiagMatrix, symbols
        @@ -1778,7 +1778,7 @@ 

        Block Matrices
        -get_diag_blocks()[source]
        +get_diag_blocks()[source]

        Return the list of diagonal blocks of the matrix.

        Examples

        >>> from sympy import BlockDiagMatrix, Matrix
        @@ -1807,7 +1807,7 @@ 

        Block Matrices
        -sympy.matrices.expressions.blockmatrix.block_collapse(expr)[source]
        +sympy.matrices.expressions.blockmatrix.block_collapse(expr)[source]

        Evaluates a block matrix expression

        >>> from sympy import MatrixSymbol, BlockMatrix, symbols, Identity, ZeroMatrix, block_collapse
         >>> n,m,l = symbols('n m l')
        diff --git a/dev/modules/matrices/immutablematrices.html b/dev/modules/matrices/immutablematrices.html
        index 582d8f747f0..1a8ab5a41cb 100644
        --- a/dev/modules/matrices/immutablematrices.html
        +++ b/dev/modules/matrices/immutablematrices.html
        @@ -835,13 +835,13 @@ 

        Immutable Matrices

        ImmutableMatrix Class Reference

        -sympy.matrices.immutable.ImmutableMatrix[source]
        +sympy.matrices.immutable.ImmutableMatrix[source]

        alias of ImmutableDenseMatrix

        -class sympy.matrices.immutable.ImmutableDenseMatrix(*args, **kwargs)[source]
        +class sympy.matrices.immutable.ImmutableDenseMatrix(*args, **kwargs)[source]

        Create an immutable version of a matrix.

        Examples

        >>> from sympy import eye, ImmutableMatrix
        diff --git a/dev/modules/matrices/kind.html b/dev/modules/matrices/kind.html
        index 69ae955aa42..4a4b4ffa185 100644
        --- a/dev/modules/matrices/kind.html
        +++ b/dev/modules/matrices/kind.html
        @@ -805,7 +805,7 @@ 
        Documentation Version

        Matrix Kind

        -class sympy.matrices.kind.MatrixKind(element_kind=NumberKind)[source]
        +class sympy.matrices.kind.MatrixKind(element_kind=NumberKind)[source]

        Kind for all matrices in SymPy.

        Basic class for this kind is MatrixBase and MatrixExpr, but any expression representing the matrix can have this.

        diff --git a/dev/modules/matrices/matrices.html b/dev/modules/matrices/matrices.html index c111e059e5b..d3e1a957a31 100644 --- a/dev/modules/matrices/matrices.html +++ b/dev/modules/matrices/matrices.html @@ -1327,7 +1327,7 @@

        Matrix Base ClassesSparse Matrices.

        -class sympy.matrices.matrixbase.MatrixBase[source]
        +class sympy.matrices.matrixbase.MatrixBase[source]

        All common matrix operations including basic arithmetic, shaping, and special matrices like \(zeros\), and \(eye\).

        @@ -1404,7 +1404,7 @@

        Matrix Base Classes
        -LDLdecomposition(hermitian=True)[source]
        +LDLdecomposition(hermitian=True)[source]

        Returns the LDL Decomposition (L, D) of matrix A, such that L * D * L.H == A if hermitian flag is True, or L * D * L.T == A if hermitian is False. @@ -1454,7 +1454,7 @@

        Matrix Base Classes
        -LDLsolve(rhs)[source]
        +LDLsolve(rhs)[source]

        Solves Ax = B using LDL decomposition, for a general square and non-singular matrix.

        For a non-square matrix with rows > cols, @@ -1483,7 +1483,7 @@

        Matrix Base Classesrankcheck=False,

        -)[source] +)[source]

        Returns (L, U, perm) where L is a lower triangular matrix with unit diagonal, U is an upper triangular matrix, and perm is a list of row swap index pairs. If A is the original matrix, then @@ -1546,7 +1546,7 @@

        Matrix Base Classes
        -LUdecompositionFF()[source]
        +LUdecompositionFF()[source]

        Compute a fraction-free LU decomposition.

        Returns 4 matrices P, L, D, U such that PA = L D**-1 U. If the elements of the matrix belong to some integral domain I, then all @@ -1576,7 +1576,7 @@

        Matrix Base Classesrankcheck=False,

        -)[source] +)[source]

        Compute the PLU decomposition of the matrix.

        Parameters:
        @@ -1846,7 +1846,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Solve the linear system Ax = rhs for x where A = M.

        This is for symbolic matrices, for real or complex ones use mpmath.lu_solve or mpmath.qr_solve.

        @@ -1858,7 +1858,7 @@

        Matrix Base Classes
        -QRdecomposition()[source]
        +QRdecomposition()[source]

        Returns a QR decomposition.

        Explanation

        A QR decomposition is a decomposition in the form \(A = Q R\) @@ -2030,7 +2030,7 @@

        Matrix Base Classes
        -QRsolve(b)[source]
        +QRsolve(b)[source]

        Solve the linear system Ax = b.

        M is the matrix A, the method argument is the vector b. The method returns the solution vector x. If b is a @@ -2056,19 +2056,19 @@

        Matrix Base Classes
        -__abs__()[source]
        +__abs__()[source]

        Returns a new matrix with entry-wise absolute values.

        -__add__(other)[source]
        +__add__(other)[source]

        Return self + other, raising ShapeError if shapes do not match.

        -__getitem__(key)[source]
        +__getitem__(key)[source]

        Implementations of __getitem__ should accept ints, in which case the matrix is indexed as a flat list, tuples (i,j) in which case the (i,j) entry is returned, slices, or mixed tuples (a,b) @@ -2077,14 +2077,14 @@

        Matrix Base Classes
        -__len__()[source]
        +__len__()[source]

        Return the number of elements of self.

        Implemented mainly so bool(Matrix()) == False.

        -__mul__(other)[source]
        +__mul__(other)[source]

        Return self*other where other is either a scalar or a matrix of compatible dimensions.

        Examples

        @@ -2112,7 +2112,7 @@

        Matrix Base Classes
        -__pow__(exp)[source]
        +__pow__(exp)[source]

        Return self**exp a scalar or symbol.

        @@ -2124,19 +2124,19 @@

        Matrix Base Classes
        -add(b)[source]
        +add(b)[source]

        Return self + b.

        -adjoint()[source]
        +adjoint()[source]

        Conjugate transpose or Hermitian conjugation.

        -adjugate(method='berkowitz')[source]
        +adjugate(method='berkowitz')[source]

        Returns the adjugate, or classical adjoint, of a matrix. That is, the transpose of the matrix of cofactors.

        https://en.wikipedia.org/wiki/Adjugate

        @@ -2166,7 +2166,7 @@

        Matrix Base Classes
        -analytic_func(f, x)[source]
        +analytic_func(f, x)[source]

        Computes f(A) where A is a Square Matrix and f is an analytic function.

        @@ -2198,7 +2198,7 @@

        Matrix Base Classes
        -applyfunc(f)[source]
        +applyfunc(f)[source]

        Apply a function to each element of the matrix.

        Examples

        >>> from sympy import Matrix
        @@ -2217,13 +2217,13 @@ 

        Matrix Base Classes
        -as_real_imag(deep=True, **hints)[source]
        +as_real_imag(deep=True, **hints)[source]

        Returns a tuple containing the (real, imaginary) part of matrix.

        -atoms(*types)[source]
        +atoms(*types)[source]

        Returns the atoms that form the current object.

        Examples

        >>> from sympy.abc import x, y
        @@ -2244,7 +2244,7 @@ 

        Matrix Base Classes
        -berkowitz_det()[source]
        +berkowitz_det()[source]

        Computes determinant using Berkowitz method.

        See also

        @@ -2254,19 +2254,19 @@

        Matrix Base Classes
        -berkowitz_eigenvals(**flags)[source]
        +berkowitz_eigenvals(**flags)[source]

        Computes eigenvalues of a Matrix using Berkowitz method.

        -berkowitz_minors()[source]
        +berkowitz_minors()[source]

        Computes principal minors using Berkowitz method.

        -bidiagonal_decomposition(upper=True)[source]
        +bidiagonal_decomposition(upper=True)[source]

        Returns \((U,B,V.H)\) for

        @@ -2298,7 +2298,7 @@

        Matrix Base Classes
        -bidiagonalize(upper=True)[source]
        +bidiagonalize(upper=True)[source]

        Returns \(B\), the Bidiagonalized form of the input matrix.

        Note: Bidiagonal Computation can hang for symbolic matrices.

        @@ -2331,7 +2331,7 @@

        Matrix Base Classessimplify=<function _simplify>,

        -)[source] +)[source]

        Computes characteristic polynomial det(x*I - M) where I is the identity matrix.

        A PurePoly is returned, so using different variables for x does @@ -2400,7 +2400,7 @@

        Matrix Base Classes
        -cholesky(hermitian=True)[source]
        +cholesky(hermitian=True)[source]

        Returns the Cholesky-type decomposition L of a matrix A such that L * L.H == A if hermitian flag is True, or L * L.T == A if hermitian is False.

        @@ -2454,7 +2454,7 @@

        Matrix Base Classes
        -cholesky_solve(rhs)[source]
        +cholesky_solve(rhs)[source]

        Solves Ax = B using Cholesky decomposition, for a general square non-singular matrix. For a non-square matrix with rows > cols, @@ -2467,7 +2467,7 @@

        Matrix Base Classes
        -cofactor(i, j, method='berkowitz')[source]
        +cofactor(i, j, method='berkowitz')[source]

        Calculate the cofactor of an element.

        Parameters:
        @@ -2493,7 +2493,7 @@

        Matrix Base Classes
        -cofactor_matrix(method='berkowitz')[source]
        +cofactor_matrix(method='berkowitz')[source]

        Return a matrix containing the cofactor of each element.

        Parameters:
        @@ -2521,7 +2521,7 @@

        Matrix Base Classes
        -col(j)[source]
        +col(j)[source]

        Elementary column selector.

        Examples

        >>> from sympy import eye
        @@ -2539,13 +2539,13 @@ 

        Matrix Base Classes
        -col_del(col)[source]
        +col_del(col)[source]

        Delete the specified column.

        -col_insert(pos, other)[source]
        +col_insert(pos, other)[source]

        Insert one or more columns at the given column position.

        Examples

        >>> from sympy import zeros, ones
        @@ -2566,7 +2566,7 @@ 

        Matrix Base Classes
        -col_join(other)[source]
        +col_join(other)[source]

        Concatenates two matrices along self’s last and other’s first row.

        Examples

        >>> from sympy import zeros, ones
        @@ -2588,7 +2588,7 @@ 

        Matrix Base Classes
        -columnspace(simplify=False)[source]
        +columnspace(simplify=False)[source]

        Returns a list of vectors (Matrix objects) that span columnspace of M

        Examples

        >>> from sympy import Matrix
        @@ -2616,7 +2616,7 @@ 

        Matrix Base Classes
        -classmethod companion(poly)[source]
        +classmethod companion(poly)[source]

        Returns a companion matrix of a polynomial.

        Examples

        >>> from sympy import Matrix, Poly, Symbol, symbols
        @@ -2636,7 +2636,7 @@ 

        Matrix Base Classes
        -condition_number()[source]
        +condition_number()[source]

        Returns the condition number of a matrix.

        This is the maximum singular value divided by the minimum singular value

        Examples

        @@ -2654,7 +2654,7 @@

        Matrix Base Classes
        -conjugate()[source]
        +conjugate()[source]

        Return the by-element conjugation.

        Examples

        >>> from sympy import SparseMatrix, I
        @@ -2686,7 +2686,7 @@ 

        Matrix Base Classes
        -connected_components()[source]
        +connected_components()[source]

        Returns the list of connected vertices of the graph when a square matrix is viewed as a weighted graph.

        Examples

        @@ -2714,7 +2714,7 @@

        Matrix Base Classes
        -connected_components_decomposition()[source]
        +connected_components_decomposition()[source]

        Decomposes a square matrix into block diagonal form only using the permutations.

        @@ -2783,7 +2783,7 @@

        Matrix Base Classes
        -copy()[source]
        +copy()[source]

        Returns the copy of a matrix.

        Examples

        >>> from sympy import Matrix
        @@ -2798,7 +2798,7 @@ 

        Matrix Base Classes
        -cramer_solve(rhs, det_method='laplace')[source]
        +cramer_solve(rhs, det_method='laplace')[source]

        Solves system of linear equations using Cramer’s rule.

        This method is relatively inefficient compared to other methods. However it only uses a single division, assuming a division-free determinant @@ -2852,7 +2852,7 @@

        Matrix Base Classes
        -cross(b)[source]
        +cross(b)[source]

        Return the cross product of self and b relaxing the condition of compatible dimensions: if each has 3 elements, a matrix of the same type and shape as self will be returned. If b has the same @@ -2871,7 +2871,7 @@

        Matrix Base Classes
        -det(method='bareiss', iszerofunc=None)[source]
        +det(method='bareiss', iszerofunc=None)[source]

        Computes the determinant of a matrix if M is a concrete matrix object otherwise return an expressions Determinant(M) if M is a MatrixSymbol or other expression.

        @@ -2959,7 +2959,7 @@

        Matrix Base Classes
        -det_LU_decomposition()[source]
        +det_LU_decomposition()[source]

        Compute matrix determinant using LU decomposition.

        Note that this method fails if the LU decomposition itself fails. In particular, if the matrix has no inverse this method @@ -2985,7 +2985,7 @@

        Matrix Base Classes**kwargs,

        -)[source] +)[source]

        Returns a matrix with the specified diagonal. If matrices are passed, a block-diagonal matrix is created (i.e. the “direct sum” of the matrices).

        @@ -3069,7 +3069,7 @@

        Matrix Base Classes
        -diagonal(k=0)[source]
        +diagonal(k=0)[source]

        Returns the kth diagonal of self. The main diagonal corresponds to \(k=0\); diagonals above and below correspond to \(k > 0\) and \(k < 0\), respectively. The values of \(self[i, j]\) @@ -3104,7 +3104,7 @@

        Matrix Base Classes
        -diagonal_solve(rhs)[source]
        +diagonal_solve(rhs)[source]

        Solves Ax = B efficiently, where A is a diagonal Matrix, with non-zero diagonal entries.

        Examples

        @@ -3131,7 +3131,7 @@

        Matrix Base Classesnormalize=False,

        -)[source] +)[source]

        Return (P, D), where D is diagonal and

        D = P^-1 * M * P

        @@ -3181,7 +3181,7 @@

        Matrix Base Classes
        -diff(*args, evaluate=True, **kwargs)[source]
        +diff(*args, evaluate=True, **kwargs)[source]

        Calculate the derivative of each element in the matrix.

        Examples

        >>> from sympy import Matrix
        @@ -3209,7 +3209,7 @@ 

        Matrix Base Classesconjugate_convention=None,

        -)[source] +)[source]

        Return the dot or inner product of two vectors of equal length. Here self must be a Matrix of size 1 x n or n x 1, and b must be either a matrix of size 1 x n, n x 1, or a list/tuple of length n. @@ -3259,7 +3259,7 @@

        Matrix Base Classes
        -dual()[source]
        +dual()[source]

        Returns the dual of a matrix.

        A dual of a matrix is:

        (1/2)*levicivita(i, j, k, l)*M(k, l) summed over indices \(k\) and \(l\)

        @@ -3280,7 +3280,7 @@

        Matrix Base Classeswith_pivots=False,

        -)[source] +)[source]

        Returns a matrix row-equivalent to M that is in echelon form. Note that echelon form of a matrix is not unique, however, properties like the row space and the null space are preserved.

        @@ -3304,7 +3304,7 @@

        Matrix Base Classes**flags,

        -)[source] +)[source]

        Compute eigenvalues of the matrix.

        Parameters:
        @@ -3388,7 +3388,7 @@

        Matrix Base Classes**flags,

        -)[source] +)[source]

        Compute eigenvectors of the matrix.

        Parameters:
        @@ -3474,7 +3474,7 @@

        Matrix Base Classescol2=None,

        -)[source] +)[source]

        Performs the elementary column operation \(op\).

        \(op\) may be one of

        @@ -3510,7 +3510,7 @@

        Matrix Base Classesrow2=None,

        -)[source] +)[source]

        Performs the elementary row operation \(op\).

        \(op\) may be one of

        @@ -3548,13 +3548,13 @@

        Matrix Base Classesverbose=False,

        -)[source] +)[source]

        Apply evalf() to each element of self.

        -exp()[source]
        +exp()[source]

        Return the exponential of a square matrix.

        Examples

        >>> from sympy import Symbol, Matrix
        @@ -3586,7 +3586,7 @@ 

        Matrix Base Classes**hints,

        -)[source] +)[source]

        Apply core.function.expand to each entry of the matrix.

        Examples

        >>> from sympy.abc import x
        @@ -3601,7 +3601,7 @@ 

        Matrix Base Classes
        -extract(rowsList, colsList)[source]
        +extract(rowsList, colsList)[source]

        Return a submatrix by specifying a list of rows and columns. Negative indices can be given. All indices must be in the range \(-n \le i < n\) where \(n\) is the number of rows or columns.

        @@ -3650,7 +3650,7 @@

        Matrix Base Classes
        -classmethod eye(rows, cols=None, **kwargs)[source]
        +classmethod eye(rows, cols=None, **kwargs)[source]

        Returns an identity matrix.

        Parameters:
        @@ -3664,7 +3664,7 @@

        Matrix Base Classes
        -flat()[source]
        +flat()[source]

        Returns a flat list of all elements in the matrix.

        Examples

        >>> from sympy import Matrix
        @@ -3694,7 +3694,7 @@ 

        Matrix Base Classes
        -classmethod from_dok(rows, cols, dok)[source]
        +classmethod from_dok(rows, cols, dok)[source]

        Create a matrix from a dictionary of keys.

        Examples

        >>> from sympy import Matrix
        @@ -3710,7 +3710,7 @@ 

        Matrix Base Classes
        -gauss_jordan_solve(B, freevar=False)[source]
        +gauss_jordan_solve(B, freevar=False)[source]

        Solves Ax = B using Gauss Jordan elimination.

        There may be zero, one, or infinite solutions. If one solution exists, it will be returned. If infinite solutions exist, it will @@ -3836,7 +3836,7 @@

        Matrix Base Classes
        -get_diag_blocks()[source]
        +get_diag_blocks()[source]

        Obtains the square sub-matrices on the main diagonal of a square matrix.

        Useful for inverting symbolic matrices or solving systems of linear equations which may be decoupled by having a block diagonal @@ -3860,7 +3860,7 @@

        Matrix Base Classes
        -has(*patterns)[source]
        +has(*patterns)[source]

        Test whether any subexpression matches any of the patterns.

        Examples

        >>> from sympy import Matrix, SparseMatrix, Float
        @@ -3885,7 +3885,7 @@ 

        Matrix Base Classes
        -hat()[source]
        +hat()[source]

        Return the skew-symmetric matrix representing the cross product, so that self.hat() * b is equivalent to self.cross(b).

        Examples

        @@ -3924,7 +3924,7 @@

        Matrix Base Classes
        -classmethod hstack(*args)[source]
        +classmethod hstack(*args)[source]

        Return a matrix formed by joining args horizontally (i.e. by repeated application of row_join).

        Examples

        @@ -3939,7 +3939,7 @@

        Matrix Base Classes
        -integrate(*args, **kwargs)[source]
        +integrate(*args, **kwargs)[source]

        Integrate each element of the matrix. args will be passed to the integrate function.

        Examples

        @@ -3972,7 +3972,7 @@

        Matrix Base Classestry_block_diag=False,

        -)[source] +)[source]

        Return the inverse of a matrix using the method indicated. The default is DM if a suitable domain is found or otherwise GE for dense matrices LDL for sparse matrices.

        @@ -4061,7 +4061,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Calculates the inverse using the adjugate matrix and a determinant.

        See also

        @@ -4077,7 +4077,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Calculates the inverse using BLOCKWISE inversion.

        See also

        @@ -4093,7 +4093,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Calculates the inverse using cholesky decomposition.

        See also

        @@ -4109,7 +4109,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Calculates the inverse using Gaussian elimination.

        See also

        @@ -4125,7 +4125,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Calculates the inverse using LDL decomposition.

        See also

        @@ -4141,7 +4141,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Calculates the inverse using LU decomposition.

        See also

        @@ -4157,7 +4157,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Calculates the inverse using QR decomposition.

        See also

        @@ -4167,7 +4167,7 @@

        Matrix Base Classes
        -classmethod irregular(ntop, *matrices, **kwargs)[source]
        +classmethod irregular(ntop, *matrices, **kwargs)[source]

        Return a matrix filled by the given matrices which are listed in order of appearance from left to right, top to bottom as they first appear in the matrix. They must fill the @@ -4187,7 +4187,7 @@

        Matrix Base Classes
        -is_anti_symmetric(simplify=True)[source]
        +is_anti_symmetric(simplify=True)[source]

        Check if matrix M is an antisymmetric matrix, that is, M is a square matrix with all M[i, j] == -M[j, i].

        When simplify=True (default), the sum M[i, j] + M[j, i] is @@ -4251,7 +4251,7 @@

        Matrix Base Classes
        -is_diagonal()[source]
        +is_diagonal()[source]

        Check if matrix is diagonal, that is matrix in which the entries outside the main diagonal are all zero.

        Examples

        @@ -4299,7 +4299,7 @@

        Matrix Base Classes**kwargs,

        -)[source] +)[source]

        Returns True if a matrix is diagonalizable.

        Parameters:
        @@ -4960,7 +4960,7 @@

        Matrix Base Classes
        -is_nilpotent()[source]
        +is_nilpotent()[source]

        Checks if a matrix is nilpotent.

        A matrix B is nilpotent if for some integer k, B**k is a zero matrix.

        @@ -5378,7 +5378,7 @@

        Matrix Base Classes
        -is_symbolic()[source]
        +is_symbolic()[source]

        Checks if any elements contain Symbols.

        Examples

        >>> from sympy import Matrix
        @@ -5392,7 +5392,7 @@ 

        Matrix Base Classes
        -is_symmetric(simplify=True)[source]
        +is_symmetric(simplify=True)[source]

        Check if matrix is symmetric matrix, that is square matrix and is equal to its transpose.

        By default, simplifications occur before testing symmetry. @@ -5581,7 +5581,7 @@

        Matrix Base Classes
        -iter_items()[source]
        +iter_items()[source]

        Iterate over indices and values of nonzero items.

        Examples

        >>> from sympy import Matrix
        @@ -5598,7 +5598,7 @@ 

        Matrix Base Classes
        -iter_values()[source]
        +iter_values()[source]

        Iterate over non-zero values of self.

        Examples

        >>> from sympy import Matrix
        @@ -5615,7 +5615,7 @@ 

        Matrix Base Classes
        -jacobian(X)[source]
        +jacobian(X)[source]

        Calculates the Jacobian matrix (derivative of a vector-valued function).

        Parameters:
        @@ -5660,7 +5660,7 @@

        Matrix Base Classes**kwargs,

        -)[source] +)[source]

        Returns a Jordan block

        Parameters:
        @@ -5752,7 +5752,7 @@

        Matrix Base Classes**kwargs,

        -)[source] +)[source]

        Return \((P, J)\) where \(J\) is a Jordan block matrix and \(P\) is a matrix such that \(M = P J P^{-1}\)

        @@ -5790,7 +5790,7 @@

        Matrix Base Classes
        -key2bounds(keys)[source]
        +key2bounds(keys)[source]

        Converts a key with potentially mixed types of keys (integer and slice) into a tuple of ranges and raises an error if any index is out of self’s range.

        @@ -5802,7 +5802,7 @@

        Matrix Base Classes
        -key2ij(key)[source]
        +key2ij(key)[source]

        Converts key into canonical form, converting integers or indexable items into valid integers for self’s range or returning slices unchanged.

        @@ -5814,7 +5814,7 @@

        Matrix Base Classes
        -left_eigenvects(**flags)[source]
        +left_eigenvects(**flags)[source]

        Returns left eigenvectors and eigenvalues.

        This function returns the list of triples (eigenval, multiplicity, basis) for the left eigenvectors. Options are the same as for @@ -5843,7 +5843,7 @@

        Matrix Base Classes
        -limit(*args)[source]
        +limit(*args)[source]

        Calculate the limit of each element in the matrix. args will be passed to the limit function.

        Examples

        @@ -5864,7 +5864,7 @@

        Matrix Base Classes
        -log(simplify=<function cancel>)[source]
        +log(simplify=<function cancel>)[source]

        Return the logarithm of a square matrix.

        Parameters:
        @@ -5921,7 +5921,7 @@

        Matrix Base Classes
        -lower_triangular(k=0)[source]
        +lower_triangular(k=0)[source]

        Return the elements on and below the kth diagonal of a matrix. If k is not specified then simply returns lower-triangular portion of a matrix

        @@ -5956,7 +5956,7 @@

        Matrix Base Classes
        -lower_triangular_solve(rhs)[source]
        +lower_triangular_solve(rhs)[source]

        Solves Ax = B, where A is a lower triangular matrix.

        See also

        @@ -5966,7 +5966,7 @@

        Matrix Base Classes
        -minor(i, j, method='berkowitz')[source]
        +minor(i, j, method='berkowitz')[source]

        Return the (i,j) minor of M. That is, return the determinant of the matrix obtained by deleting the \(i`th row and `j`th column from ``M`\).

        @@ -5998,7 +5998,7 @@

        Matrix Base Classes
        -minor_submatrix(i, j)[source]
        +minor_submatrix(i, j)[source]

        Return the submatrix obtained by removing the \(i`th row and `j`th column from ``M`\) (works with Pythonic negative indices).

        @@ -6026,7 +6026,7 @@

        Matrix Base Classes
        -multiply(other, dotprodsimp=None)[source]
        +multiply(other, dotprodsimp=None)[source]

        Same as __mul__() but with optional simplification.

        Parameters:
        @@ -6042,7 +6042,7 @@

        Matrix Base Classes
        -multiply_elementwise(other)[source]
        +multiply_elementwise(other)[source]

        Return the Hadamard product (elementwise product) of A and B

        Examples

        >>> from sympy import Matrix
        @@ -6062,13 +6062,13 @@ 

        Matrix Base Classes
        -n(*args, **kwargs)[source]
        +n(*args, **kwargs)[source]

        Apply evalf() to each element of self.

        -norm(ord=None)[source]
        +norm(ord=None)[source]

        Return the Norm of a Matrix or Vector.

        In the simplest case this is the geometric size of the vector Other norms can be specified by the ord parameter

        @@ -6165,7 +6165,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Return the normalized version of self.

        Parameters:
        @@ -6206,7 +6206,7 @@

        Matrix Base Classesiszerofunc=<function _iszero>,

        -)[source] +)[source]

        Returns list of vectors (Matrix objects) that span nullspace of M

        Examples

        >>> from sympy import Matrix
        @@ -6231,7 +6231,7 @@ 

        Matrix Base Classes
        -classmethod ones(rows, cols=None, **kwargs)[source]
        +classmethod ones(rows, cols=None, **kwargs)[source]

        Returns a matrix of ones.

        Parameters:
        @@ -6245,7 +6245,7 @@

        Matrix Base Classes
        -classmethod orthogonalize(*vecs, **kwargs)[source]
        +classmethod orthogonalize(*vecs, **kwargs)[source]

        Apply the Gram-Schmidt orthogonalization procedure to vectors supplied in vecs.

        @@ -6299,7 +6299,7 @@

        Matrix Base Classes
        -per()[source]
        +per()[source]

        Returns the permanent of a matrix. Unlike determinant, permanent is defined for both square and non-square matrices.

        For an m x n matrix, with m less than or equal to n, @@ -6352,7 +6352,7 @@

        Matrix Base Classesdirection='forward',

        -)[source] +)[source]

        Permute the rows or columns of a matrix by the given list of swaps.

        @@ -6446,13 +6446,13 @@

        Matrix Base Classes
        -permuteBkwd(perm)[source]
        +permuteBkwd(perm)[source]

        Permute the rows of the matrix with the given permutation in reverse.

        -permuteFwd(perm)[source]
        +permuteFwd(perm)[source]

        Permute the rows of the matrix with the given permutation.

        @@ -6465,7 +6465,7 @@

        Matrix Base Classesdirection='forward',

        -)[source] +)[source]

        Alias for self.permute(swaps, orientation='cols', direction=direction)

        @@ -6483,7 +6483,7 @@

        Matrix Base Classesdirection='forward',

        -)[source] +)[source]

        Alias for self.permute(swaps, orientation='rows', direction=direction)

        @@ -6494,7 +6494,7 @@

        Matrix Base Classes
        -pinv(method='RD')[source]
        +pinv(method='RD')[source]

        Calculate the Moore-Penrose pseudoinverse of the matrix.

        The Moore-Penrose pseudoinverse exists and is unique for any matrix. If the matrix is invertible, the pseudoinverse is the same as the @@ -6545,7 +6545,7 @@

        Matrix Base Classes
        -pinv_solve(B, arbitrary_matrix=None)[source]
        +pinv_solve(B, arbitrary_matrix=None)[source]

        Solve Ax = B using the Moore-Penrose pseudoinverse.

        There may be zero, one, or infinite solutions. If one solution exists, it will be returned. If infinite solutions exist, one will @@ -6616,7 +6616,7 @@

        Matrix Base Classes
        -pow(exp, method=None)[source]
        +pow(exp, method=None)[source]

        Return self**exp a scalar or symbol.

        Parameters:
        @@ -6638,7 +6638,7 @@

        Matrix Base Classes
        -print_nonzero(symb='X')[source]
        +print_nonzero(symb='X')[source]

        Shows location of non-zero entries for fast shape lookup.

        Examples

        >>> from sympy import Matrix, eye
        @@ -6662,7 +6662,7 @@ 

        Matrix Base Classes
        -project(v)[source]
        +project(v)[source]

        Return the projection of self onto the line containing v.

        Examples

        >>> from sympy import Matrix, S, sqrt
        @@ -6685,7 +6685,7 @@ 

        Matrix Base Classessimplify=False,

        -)[source] +)[source]

        Returns the rank of a matrix.

        Examples

        >>> from sympy import Matrix
        @@ -6709,7 +6709,7 @@ 

        Matrix Base Classessimplify=False,

        -)[source] +)[source]

        Returns a pair of matrices (\(C\), \(F\)) with matching rank such that \(A = C F\).

        @@ -6797,7 +6797,7 @@

        Matrix Base Classes
        -refine(assumptions=True)[source]
        +refine(assumptions=True)[source]

        Apply refine to each element of the matrix.

        Examples

        >>> from sympy import Symbol, Matrix, Abs, sqrt, Q
        @@ -6826,7 +6826,7 @@ 

        Matrix Base Classesexact=None,

        -)[source] +)[source]

        Replaces Function F in Matrix entries with Function G.

        Examples

        >>> from sympy import symbols, Function, Matrix
        @@ -6846,7 +6846,7 @@ 

        Matrix Base Classes
        -reshape(rows, cols)[source]
        +reshape(rows, cols)[source]

        Reshape the matrix. Total number of elements must remain the same.

        Examples

        >>> from sympy import Matrix
        @@ -6868,7 +6868,7 @@ 

        Matrix Base Classes
        -rmultiply(other, dotprodsimp=None)[source]
        +rmultiply(other, dotprodsimp=None)[source]

        Same as __rmul__() but with optional simplification.

        Parameters:
        @@ -6884,7 +6884,7 @@

        Matrix Base Classes
        -rot90(k=1)[source]
        +rot90(k=1)[source]

        Rotates Matrix by 90 degrees

        Parameters:
        @@ -6922,7 +6922,7 @@

        Matrix Base Classes
        -row(i)[source]
        +row(i)[source]

        Elementary row selector.

        Examples

        >>> from sympy import eye
        @@ -6938,13 +6938,13 @@ 

        Matrix Base Classes
        -row_del(row)[source]
        +row_del(row)[source]

        Delete the specified row.

        -row_insert(pos, other)[source]
        +row_insert(pos, other)[source]

        Insert one or more rows at the given row position.

        Examples

        >>> from sympy import zeros, ones
        @@ -6966,7 +6966,7 @@ 

        Matrix Base Classes
        -row_join(other)[source]
        +row_join(other)[source]

        Concatenates two matrices along self’s last and rhs’s first column

        Examples

        >>> from sympy import zeros, ones
        @@ -6987,7 +6987,7 @@ 

        Matrix Base Classes
        -rowspace(simplify=False)[source]
        +rowspace(simplify=False)[source]

        Returns a list of vectors that span the row space of M.

        Examples

        >>> from sympy import Matrix
        @@ -7014,7 +7014,7 @@ 

        Matrix Base Classesnormalize_last=True,

        -)[source] +)[source]

        Return reduced row-echelon form of matrix and indices of pivot vars.

        @@ -7090,7 +7090,7 @@

        Matrix Base Classes
        -rref_rhs(rhs)[source]
        +rref_rhs(rhs)[source]

        Return reduced row-echelon form of matrix, matrix showing rhs after reduction steps. rhs must have the same number of rows as self.

        @@ -7126,7 +7126,7 @@

        Matrix Base Classes
        -simplify(**kwargs)[source]
        +simplify(**kwargs)[source]

        Apply simplify to each element of the matrix.

        Examples

        >>> from sympy.abc import x, y
        @@ -7141,7 +7141,7 @@ 

        Matrix Base Classes
        -singular_value_decomposition()[source]
        +singular_value_decomposition()[source]

        Returns a Condensed Singular Value decomposition.

        Explanation

        A Singular Value decomposition is a decomposition in the form \(A = U \Sigma V^H\) @@ -7312,7 +7312,7 @@

        Matrix Base Classes
        -singular_values()[source]
        +singular_values()[source]

        Compute the singular values of a Matrix

        Examples

        >>> from sympy import Matrix, Symbol
        @@ -7330,7 +7330,7 @@ 

        Matrix Base Classes
        -solve(rhs, method='GJ')[source]
        +solve(rhs, method='GJ')[source]

        Solves linear equation where the unique solution exists.

        Parameters:
        @@ -7374,7 +7374,7 @@

        Matrix Base Classes
        -solve_least_squares(rhs, method='CH')[source]
        +solve_least_squares(rhs, method='CH')[source]

        Return the least-square fit to the data.

        Parameters:
        @@ -7449,7 +7449,7 @@

        Matrix Base Classes
        -strongly_connected_components()[source]
        +strongly_connected_components()[source]

        Returns the list of strongly connected vertices of the graph when a square matrix is viewed as a weighted graph.

        Examples

        @@ -7478,7 +7478,7 @@

        Matrix Base Classeslower=True,

        -)[source] +)[source]

        Decomposes a square matrix into block triangular form only using the permutations.

        @@ -7579,7 +7579,7 @@

        Matrix Base Classes
        -subs(*args, **kwargs)[source]
        +subs(*args, **kwargs)[source]

        Return a new matrix with subs applied to each entry.

        Examples

        >>> from sympy.abc import x, y
        @@ -7607,7 +7607,7 @@ 

        Matrix Base Classesalign='right',

        -)[source] +)[source]

        String form of Matrix as a table.

        printer is the printer to use for on the elements (generally something like StrPrinter())

        @@ -7649,7 +7649,7 @@

        Matrix Base Classes
        -todod()[source]
        +todod()[source]

        Returns matrix as dict of dicts containing non-zero elements of the Matrix

        Examples

        >>> from sympy import Matrix
        @@ -7666,7 +7666,7 @@ 

        Matrix Base Classes
        -todok()[source]
        +todok()[source]

        Return the matrix as dictionary of keys.

        Examples

        >>> from sympy import Matrix
        @@ -7679,7 +7679,7 @@ 

        Matrix Base Classes
        -tolist()[source]
        +tolist()[source]

        Return the Matrix as a nested Python list.

        Examples

        >>> from sympy import Matrix, ones
        @@ -7705,7 +7705,7 @@ 

        Matrix Base Classes
        -trace()[source]
        +trace()[source]

        Returns the trace of a square matrix i.e. the sum of the diagonal elements.

        Examples

        @@ -7719,7 +7719,7 @@

        Matrix Base Classes
        -transpose()[source]
        +transpose()[source]

        Returns the transpose of the matrix.

        Examples

        >>> from sympy import Matrix
        @@ -7755,7 +7755,7 @@ 

        Matrix Base Classes
        -upper_hessenberg_decomposition()[source]
        +upper_hessenberg_decomposition()[source]

        Converts a matrix into Hessenberg matrix H.

        Returns 2 matrices H, P s.t. \(P H P^{T} = A\), where H is an upper hessenberg matrix @@ -7793,7 +7793,7 @@

        Matrix Base Classes
        -upper_triangular(k=0)[source]
        +upper_triangular(k=0)[source]

        Return the elements on and above the kth diagonal of a matrix. If k is not specified then simply returns upper-triangular portion of a matrix

        @@ -7828,7 +7828,7 @@

        Matrix Base Classes
        -upper_triangular_solve(rhs)[source]
        +upper_triangular_solve(rhs)[source]

        Solves Ax = B, where A is an upper triangular matrix.

        See also

        @@ -7838,7 +7838,7 @@

        Matrix Base Classes
        -values()[source]
        +values()[source]

        Return non-zero values of self.

        Examples

        >>> from sympy import Matrix
        @@ -7855,7 +7855,7 @@ 

        Matrix Base Classes
        -vec()[source]
        +vec()[source]

        Return the Matrix converted into a one column matrix by stacking columns

        Examples

        >>> from sympy import Matrix
        @@ -7887,7 +7887,7 @@ 

        Matrix Base Classescheck_symmetry=True,

        -)[source] +)[source]

        Reshapes the matrix into a column vector by stacking the elements in the lower triangle.

        @@ -7930,7 +7930,7 @@

        Matrix Base Classes
        -vee()[source]
        +vee()[source]

        Return a 3x1 vector from a skew-symmetric matrix representing the cross product, so that self * b is equivalent to self.vee().cross(b).

        Examples

        @@ -7993,7 +7993,7 @@

        Matrix Base Classes
        -classmethod vstack(*args)[source]
        +classmethod vstack(*args)[source]

        Return a matrix formed by joining args vertically (i.e. by repeated application of col_join).

        Examples

        @@ -8010,7 +8010,7 @@

        Matrix Base Classes
        -classmethod wilkinson(n, **kwargs)[source]
        +classmethod wilkinson(n, **kwargs)[source]

        Returns two square Wilkinson Matrix of size 2*n + 1 \(W_{2n + 1}^-, W_{2n + 1}^+ =\) Wilkinson(n)

        Examples

        @@ -8056,7 +8056,7 @@

        Matrix Base Classes
        -xreplace(rule)[source]
        +xreplace(rule)[source]

        Return a new matrix with xreplace applied to each entry.

        Examples

        >>> from sympy.abc import x, y
        @@ -8073,7 +8073,7 @@ 

        Matrix Base Classes
        -classmethod zeros(rows, cols=None, **kwargs)[source]
        +classmethod zeros(rows, cols=None, **kwargs)[source]

        Returns a matrix of zeros.

        Parameters:
        @@ -8092,18 +8092,18 @@

        Matrix Base Classes

        -class sympy.matrices.matrixbase.MatrixError[source]
        +class sympy.matrices.matrixbase.MatrixError[source]
        -class sympy.matrices.matrixbase.ShapeError[source]
        +class sympy.matrices.matrixbase.ShapeError[source]

        Wrong matrix shape

        -class sympy.matrices.matrixbase.NonSquareMatrixError[source]
        +class sympy.matrices.matrixbase.NonSquareMatrixError[source]
        @@ -8111,7 +8111,7 @@

        Matrix Exceptions

        -sympy.matrices.dense.matrix_multiply_elementwise(A, B)[source]
        +sympy.matrices.dense.matrix_multiply_elementwise(A, B)[source]

        Return the Hadamard product (elementwise product) of A and B

        >>> from sympy import Matrix, matrix_multiply_elementwise
         >>> A = Matrix([[0, 1, 2], [3, 4, 5]])
        @@ -8130,7 +8130,7 @@ 

        Matrix Functions
        -sympy.matrices.dense.zeros(*args, **kwargs)[source]
        +sympy.matrices.dense.zeros(*args, **kwargs)[source]

        Returns a matrix of zeros with rows rows and cols columns; if cols is omitted a square matrix will be returned.

        @@ -8141,7 +8141,7 @@

        Matrix Functions
        -sympy.matrices.dense.ones(*args, **kwargs)[source]
        +sympy.matrices.dense.ones(*args, **kwargs)[source]

        Returns a matrix of ones with rows rows and cols columns; if cols is omitted a square matrix will be returned.

        @@ -8152,7 +8152,7 @@

        Matrix Functions
        -sympy.matrices.dense.eye(*args, **kwargs)[source]
        +sympy.matrices.dense.eye(*args, **kwargs)[source]

        Create square identity matrix n x n

        See also

        @@ -8162,7 +8162,7 @@

        Matrix Functions
        -sympy.matrices.dense.diag(*values, strict=True, unpack=False, **kwargs)[source]
        +sympy.matrices.dense.diag(*values, strict=True, unpack=False, **kwargs)[source]

        Returns a matrix with the provided values placed on the diagonal. If non-square matrices are included, they will produce a block-diagonal matrix.

        @@ -8196,7 +8196,7 @@

        Matrix Functions
        -sympy.matrices.dense.jordan_cell(eigenval, n)[source]
        +sympy.matrices.dense.jordan_cell(eigenval, n)[source]

        Create a Jordan block:

        Examples

        >>> from sympy import jordan_cell
        @@ -8213,7 +8213,7 @@ 

        Matrix Functions
        -sympy.matrices.dense.hessian(f, varlist, constraints=())[source]
        +sympy.matrices.dense.hessian(f, varlist, constraints=())[source]

        Compute Hessian matrix for a function f wrt parameters in varlist which may be given as a sequence or a row/column vector. A list of constraints may optionally be given.

        @@ -8258,7 +8258,7 @@

        Matrix Functions
        -sympy.matrices.dense.GramSchmidt(vlist, orthonormal=False)[source]
        +sympy.matrices.dense.GramSchmidt(vlist, orthonormal=False)[source]

        Apply the Gram-Schmidt process to a set of vectors.

        Parameters:
        @@ -8298,7 +8298,7 @@

        Matrix Functions
        -sympy.matrices.dense.wronskian(functions, var, method='bareiss')[source]
        +sympy.matrices.dense.wronskian(functions, var, method='bareiss')[source]

        Compute Wronskian for [] of functions

                         | f1       f2        ...   fn      |
                          | f1'      f2'       ...   fn'     |
        @@ -8318,7 +8318,7 @@ 

        Matrix Functions
        -sympy.matrices.dense.casoratian(seqs, n, zero=True)[source]
        +sympy.matrices.dense.casoratian(seqs, n, zero=True)[source]

        Given linear difference operator L of order ‘k’ and homogeneous equation Ly = 0 we want to compute kernel of L, which is a set of ‘k’ sequences: a(n), b(n), … z(n).

        @@ -8362,7 +8362,7 @@

        Matrix Functionsprng=None,

        -)[source] +)[source]

        Create random matrix with dimensions r x c. If c is omitted the matrix will be square. If symmetric is True the matrix must be square. If percent is less than 100 then only approximately the given @@ -8414,7 +8414,7 @@

        Matrix Functions

        -sympy.matrices.dense.rot_givens(i, j, theta, dim=3)[source]
        +sympy.matrices.dense.rot_givens(i, j, theta, dim=3)[source]

        Returns a a Givens rotation matrix, a a rotation in the plane spanned by two coordinates axes.

        @@ -8517,7 +8517,7 @@

        Rotation matrices
        -sympy.matrices.dense.rot_axis1(theta)[source]
        +sympy.matrices.dense.rot_axis1(theta)[source]

        Returns a rotation matrix for a rotation of theta (in radians) about the 1-axis.

        Explanation

        @@ -8569,7 +8569,7 @@

        Rotation matrices
        -sympy.matrices.dense.rot_axis2(theta)[source]
        +sympy.matrices.dense.rot_axis2(theta)[source]

        Returns a rotation matrix for a rotation of theta (in radians) about the 2-axis.

        Explanation

        @@ -8621,7 +8621,7 @@

        Rotation matrices
        -sympy.matrices.dense.rot_axis3(theta)[source]
        +sympy.matrices.dense.rot_axis3(theta)[source]

        Returns a rotation matrix for a rotation of theta (in radians) about the 3-axis.

        Explanation

        @@ -8673,7 +8673,7 @@

        Rotation matrices
        -sympy.matrices.dense.rot_ccw_axis1(theta)[source]
        +sympy.matrices.dense.rot_ccw_axis1(theta)[source]

        Returns a rotation matrix for a rotation of theta (in radians) about the 1-axis.

        Explanation

        @@ -8725,7 +8725,7 @@

        Rotation matrices
        -sympy.matrices.dense.rot_ccw_axis2(theta)[source]
        +sympy.matrices.dense.rot_ccw_axis2(theta)[source]

        Returns a rotation matrix for a rotation of theta (in radians) about the 2-axis.

        Explanation

        @@ -8777,7 +8777,7 @@

        Rotation matrices
        -sympy.matrices.dense.rot_ccw_axis3(theta)[source]
        +sympy.matrices.dense.rot_ccw_axis3(theta)[source]

        Returns a rotation matrix for a rotation of theta (in radians) about the 3-axis.

        Explanation

        @@ -8832,7 +8832,7 @@

        Rotation matrices

        -sympy.matrices.dense.list2numpy(l, dtype=<class 'object'>)[source]
        +sympy.matrices.dense.list2numpy(l, dtype=<class 'object'>)[source]

        Converts Python list of SymPy expressions to a NumPy array.

        See also

        @@ -8842,7 +8842,7 @@

        Numpy Utility Functions
        -sympy.matrices.dense.matrix2numpy(m, dtype=<class 'object'>)[source]
        +sympy.matrices.dense.matrix2numpy(m, dtype=<class 'object'>)[source]

        Converts SymPy’s matrix to a NumPy array.

        See also

        @@ -8852,7 +8852,7 @@

        Numpy Utility Functions
        -sympy.matrices.dense.symarray(prefix, shape, **kwargs)[source]
        +sympy.matrices.dense.symarray(prefix, shape, **kwargs)[source]

        Create a numpy ndarray of symbols (as an object array).

        The created symbols are named prefix_i1_i2_… You should thus provide a non-empty prefix if you want your symbols to be unique for different output @@ -8921,7 +8921,7 @@

        Numpy Utility Functions
        -sympy.matrices.matrixbase.a2idx(j, n=None)[source]
        +sympy.matrices.matrixbase.a2idx(j, n=None)[source]

        Return integer after making positive and validating against n.

        diff --git a/dev/modules/matrices/normalforms.html b/dev/modules/matrices/normalforms.html index 08b6ddcd035..d9fce0ce109 100644 --- a/dev/modules/matrices/normalforms.html +++ b/dev/modules/matrices/normalforms.html @@ -805,7 +805,7 @@
        Documentation Version

        Matrix Normal Forms

        -sympy.matrices.normalforms.smith_normal_form(m, domain=None)[source]
        +sympy.matrices.normalforms.smith_normal_form(m, domain=None)[source]

        Return the Smith Normal Form of a matrix \(m\) over the ring \(domain\). This will only work if the ring is a principal ideal domain.

        Examples

        @@ -829,7 +829,7 @@
        Documentation Version
        check_rank=False,
        -)[source] +)[source]

        Compute the Hermite Normal Form of a Matrix A of integers.

        Parameters:
        diff --git a/dev/modules/matrices/sparse.html b/dev/modules/matrices/sparse.html index 41fd0300aad..d7653df9ddd 100644 --- a/dev/modules/matrices/sparse.html +++ b/dev/modules/matrices/sparse.html @@ -807,13 +807,13 @@
        Documentation Version

        SparseMatrix Class Reference

        -sympy.matrices.sparse.SparseMatrix[source]
        +sympy.matrices.sparse.SparseMatrix[source]

        alias of MutableSparseMatrix

        -class sympy.matrices.sparse.MutableSparseMatrix(*args, **kwargs)[source]
        +class sympy.matrices.sparse.MutableSparseMatrix(*args, **kwargs)[source]
        @@ -821,7 +821,7 @@

        SparseMatrix Class Reference

        -class sympy.matrices.immutable.ImmutableSparseMatrix(*args, **kwargs)[source]
        +class sympy.matrices.immutable.ImmutableSparseMatrix(*args, **kwargs)[source]

        Create an immutable version of a sparse matrix.

        Examples

        >>> from sympy import eye, ImmutableSparseMatrix
        diff --git a/dev/modules/matrices/sparsetools.html b/dev/modules/matrices/sparsetools.html
        index 014e5e8b0c5..1fcefe05430 100644
        --- a/dev/modules/matrices/sparsetools.html
        +++ b/dev/modules/matrices/sparsetools.html
        @@ -805,7 +805,7 @@ 
        Documentation Version

        Sparse Tools

        -sympy.matrices.sparsetools._doktocsr()[source]
        +sympy.matrices.sparsetools._doktocsr()[source]

        Converts a sparse matrix to Compressed Sparse Row (CSR) format.

        Parameters:
        @@ -832,7 +832,7 @@
        Documentation Version
        -sympy.matrices.sparsetools._csrtodok()[source]
        +sympy.matrices.sparsetools._csrtodok()[source]

        Converts a CSR representation to DOK representation.

        Examples

        >>> from sympy.matrices.sparsetools import _csrtodok
        @@ -848,7 +848,7 @@ 
        Documentation Version
        -sympy.matrices.sparsetools.banded(**kwargs)[source]
        +sympy.matrices.sparsetools.banded(**kwargs)[source]

        Returns a SparseMatrix from the given dictionary describing the diagonals of the matrix. The keys are positive for upper diagonals and negative for those below the main diagonal. The diff --git a/dev/modules/ntheory.html b/dev/modules/ntheory.html index 20e42f3c649..35d69342afb 100644 --- a/dev/modules/ntheory.html +++ b/dev/modules/ntheory.html @@ -807,7 +807,7 @@

        Documentation Version

        Ntheory Class Reference

        -class sympy.ntheory.generate.Sieve(sieve_interval=1000000)[source]
        +class sympy.ntheory.generate.Sieve(sieve_interval=1000000)[source]

        A list of prime numbers, implemented as a dynamically growing sieve of Eratosthenes. When a lookup is requested involving an odd number that has not been sieved, the sieve is automatically @@ -824,7 +824,7 @@

        Ntheory Class Reference
        -extend(n)[source]
        +extend(n)[source]

        Grow the sieve to cover all primes <= n.

        Examples

        >>> from sympy import sieve
        @@ -838,7 +838,7 @@ 

        Ntheory Class Reference
        -extend_to_no(i)[source]
        +extend_to_no(i)[source]

        Extend to include the ith prime number.

        Parameters:
        @@ -860,7 +860,7 @@

        Ntheory Class Reference
        -mobiusrange(a, b)[source]
        +mobiusrange(a, b)[source]

        Generate all mobius numbers for the range [a, b).

        Parameters:
        @@ -884,7 +884,7 @@

        Ntheory Class Reference
        -primerange(a, b=None)[source]
        +primerange(a, b=None)[source]

        Generate all prime numbers in the range [2, a) or [a, b).

        Examples

        >>> from sympy import sieve, prime
        @@ -909,7 +909,7 @@ 

        Ntheory Class Reference
        -search(n)[source]
        +search(n)[source]

        Return the indices i, j of the primes that bound n.

        If n is prime then i == j.

        Although n can be an expression, if ceiling cannot convert @@ -926,7 +926,7 @@

        Ntheory Class Reference
        -totientrange(a, b)[source]
        +totientrange(a, b)[source]

        Generate all totient numbers for the range [a, b).

        Examples

        >>> from sympy import sieve
        @@ -940,7 +940,7 @@ 

        Ntheory Class Reference
        -class sympy.ntheory.factor_.FactorCache(maxsize: int | None = None)[source]
        +class sympy.ntheory.factor_.FactorCache(maxsize: int | None = None)[source]

        Provides a cache for prime factors. factor_cache is pre-prepared as an instance of FactorCache, and factorint internally references it to speed up @@ -972,13 +972,13 @@

        Ntheory Class Referencefactorint.

        -cache_clear() None[source]
        +cache_clear() None[source]

        Clear the cache

        -get(n: int, default=None)[source]
        +get(n: int, default=None)[source]

        Return the prime factor of n. If it does not exist in the cache, return the value of default.

        @@ -996,7 +996,7 @@

        Ntheory Class Reference

        Ntheory Functions Reference

        -sympy.ntheory.generate.prime(nth)[source]
        +sympy.ntheory.generate.prime(nth)[source]

        Return the nth prime number, where primes are indexed starting from 1: prime(1) = 2, prime(2) = 3, etc.

        @@ -1053,7 +1053,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.primepi(n)[source]
        +sympy.ntheory.generate.primepi(n)[source]

        Represents the prime counting function pi(n) = the number of prime numbers less than or equal to n.

        @@ -1129,7 +1129,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.nextprime(n, ith=1)[source]
        +sympy.ntheory.generate.nextprime(n, ith=1)[source]

        Return the ith prime greater than n.

        Parameters:
        @@ -1170,7 +1170,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.prevprime(n)[source]
        +sympy.ntheory.generate.prevprime(n)[source]

        Return the largest prime smaller than n.

        Notes

        Potential primes are located at 6*j +/- 1. This @@ -1193,7 +1193,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.primerange(a, b=None)[source]
        +sympy.ntheory.generate.primerange(a, b=None)[source]

        Generate a list of all prime numbers in the range [2, a), or [a, b).

        If the range exists in the default sieve, the values will @@ -1290,7 +1290,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.randprime(a, b)[source]
        +sympy.ntheory.generate.randprime(a, b)[source]

        Return a random prime number in the range [a, b).

        Bertrand’s postulate assures that randprime(a, 2*a) will always succeed for a > 1.

        @@ -1325,7 +1325,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.primorial(n, nth=True)[source]
        +sympy.ntheory.generate.primorial(n, nth=True)[source]

        Returns the product of the first n primes (default) or the primes less than or equal to n (when nth=False).

        Examples

        @@ -1376,7 +1376,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.cycle_length(f, x0, nmax=None, values=False)[source]
        +sympy.ntheory.generate.cycle_length(f, x0, nmax=None, values=False)[source]

        For a given iterated sequence, return a generator that gives the length of the iterated cycle (lambda) and the length of terms before the cycle begins (mu); if values is True then the @@ -1429,7 +1429,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.composite(nth)[source]
        +sympy.ntheory.generate.composite(nth)[source]

        Return the nth composite number, with the composite numbers indexed as composite(1) = 4, composite(2) = 6, etc….

        Examples

        @@ -1461,7 +1461,7 @@

        Ntheory Class Reference
        -sympy.ntheory.generate.compositepi(n)[source]
        +sympy.ntheory.generate.compositepi(n)[source]

        Return the number of positive composite numbers less than or equal to n. The first positive composite is 4, i.e. compositepi(4) = 1.

        Examples

        @@ -1491,7 +1491,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.smoothness(n)[source]
        +sympy.ntheory.factor_.smoothness(n)[source]

        Return the B-smooth and B-power smooth values of n.

        The smoothness of n is the largest prime factor of n; the power- smoothness is the largest divisor raised to its multiplicity.

        @@ -1513,7 +1513,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.smoothness_p(n, m=-1, power=0, visual=None)[source]
        +sympy.ntheory.factor_.smoothness_p(n, m=-1, power=0, visual=None)[source]

        Return a list of [m, (p, (M, sm(p + m), psm(p + m)))…] where:

          @@ -1606,7 +1606,7 @@

          Ntheory Class Reference
          -sympy.ntheory.factor_.multiplicity(p, n)[source]
          +sympy.ntheory.factor_.multiplicity(p, n)[source]

          Find the greatest integer m such that p**m divides n.

          Examples

          >>> from sympy import multiplicity, Rational
          @@ -1647,7 +1647,7 @@ 

          Ntheory Class Referencefactor=True,

        -)[source] +)[source]

        Return (b, e) such that n == b**e if n is a unique perfect power with e > 1, else False (e.g. 1 is not a perfect power). A ValueError is raised if n is not Rational.

        @@ -1723,7 +1723,7 @@

        Ntheory Class ReferenceF=None,

        -)[source] +)[source]

        Use Pollard’s rho method to try to extract a nontrivial factor of n. The returned factor may be a composite number. If no factor is found, None is returned.

        @@ -1809,7 +1809,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.pollard_pm1(n, B=10, a=2, retries=0, seed=1234)[source]
        +sympy.ntheory.factor_.pollard_pm1(n, B=10, a=2, retries=0, seed=1234)[source]

        Use Pollard’s p-1 method to try to extract a nontrivial factor of n. Either a divisor (perhaps composite) or None is returned.

        The value of a is the base that is used in the test gcd(a**M - 1, n). @@ -1954,7 +1954,7 @@

        Ntheory Class Referencemultiple=False,

        -)[source] +)[source]

        Given a positive integer n, factorint(n) returns a dict containing the prime factors of n as keys and their respective multiplicities as values. For example:

        @@ -2131,7 +2131,7 @@

        Ntheory Class Referencemultiple=False,

        -)[source] +)[source]

        Given a Rational r, factorrat(r) returns a dict containing the prime factors of r as keys and their respective multiplicities as values. For example:

        @@ -2168,7 +2168,7 @@

        Ntheory Class Reference**kwargs,

        -)[source] +)[source]

        Return a sorted list of n’s prime factors, ignoring multiplicity and any composite factor that remains if the limit was set too low for complete factorization. Unlike factorint(), primefactors() does @@ -2217,7 +2217,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.divisors(n, generator=False, proper=False)[source]
        +sympy.ntheory.factor_.divisors(n, generator=False, proper=False)[source]

        Return all divisors of n sorted from 1..n by default. If generator is True an unordered generator is returned.

        The number of divisors of n can be quite large if there are many @@ -2246,7 +2246,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.proper_divisors(n, generator=False)[source]
        +sympy.ntheory.factor_.proper_divisors(n, generator=False)[source]

        Return all divisors of n except n, sorted by default. If generator is True an unordered generator is returned.

        Examples

        @@ -2267,7 +2267,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.divisor_count(n, modulus=1, proper=False)[source]
        +sympy.ntheory.factor_.divisor_count(n, modulus=1, proper=False)[source]

        Return the number of divisors of n. If modulus is not 1 then only those that are divisible by modulus are counted. If proper is True then the divisor of n will not be counted.

        @@ -2289,7 +2289,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.proper_divisor_count(n, modulus=1)[source]
        +sympy.ntheory.factor_.proper_divisor_count(n, modulus=1)[source]

        Return the number of proper divisors of n.

        Examples

        >>> from sympy import proper_divisor_count
        @@ -2307,7 +2307,7 @@ 

        Ntheory Class Reference
        -sympy.ntheory.factor_.udivisors(n, generator=False)[source]
        +sympy.ntheory.factor_.udivisors(n, generator=False)[source]

        Return all unitary divisors of n sorted from 1..n by default. If generator is True an unordered generator is returned.

        The number of unitary divisors of n can be quite large if there are many @@ -2344,7 +2344,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.udivisor_count(n)[source]
        +sympy.ntheory.factor_.udivisor_count(n)[source]

        Return the number of unitary divisors of n.

        Parameters:
        @@ -2372,7 +2372,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.antidivisors(n, generator=False)[source]
        +sympy.ntheory.factor_.antidivisors(n, generator=False)[source]

        Return all antidivisors of n sorted from 1..n by default.

        Antidivisors [R661] of n are numbers that do not divide n by the largest possible margin. If generator is True an unordered generator is returned.

        @@ -2402,7 +2402,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.antidivisor_count(n)[source]
        +sympy.ntheory.factor_.antidivisor_count(n)[source]

        Return the number of antidivisors [R662] of n.

        Parameters:
        @@ -2433,7 +2433,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.totient(n)[source]
        +sympy.ntheory.factor_.totient(n)[source]

        Calculate the Euler totient function phi(n)

        Deprecated since version 1.13: The totient function is deprecated. Use sympy.functions.combinatorial.numbers.totient @@ -2476,7 +2476,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.reduced_totient(n)[source]
        +sympy.ntheory.factor_.reduced_totient(n)[source]

        Calculate the Carmichael reduced totient function lambda(n)

        Deprecated since version 1.13: The reduced_totient function is deprecated. Use sympy.functions.combinatorial.numbers.reduced_totient @@ -2514,7 +2514,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.divisor_sigma(n, k=1)[source]
        +sympy.ntheory.factor_.divisor_sigma(n, k=1)[source]

        Calculate the divisor function \(\sigma_k(n)\) for positive integer n

        Deprecated since version 1.13: The divisor_sigma function is deprecated. Use sympy.functions.combinatorial.numbers.divisor_sigma @@ -2573,7 +2573,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.udivisor_sigma(n, k=1)[source]
        +sympy.ntheory.factor_.udivisor_sigma(n, k=1)[source]

        Calculate the unitary divisor function \(\sigma_k^*(n)\) for positive integer n

        Deprecated since version 1.13: The udivisor_sigma function is deprecated. Use sympy.functions.combinatorial.numbers.udivisor_sigma @@ -2629,7 +2629,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.core(n, t=2)[source]
        +sympy.ntheory.factor_.core(n, t=2)[source]

        Calculate core(n, t) = \(core_t(n)\) of a positive integer n

        core_2(n) is equal to the squarefree part of n

        If n’s prime factorization is:

        @@ -2681,7 +2681,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.digits(n, b=10, digits=None)[source]
        +sympy.ntheory.factor_.digits(n, b=10, digits=None)[source]

        Return a list of the digits of n in base b. The first element in the list is b (or -b if n is negative).

        @@ -2731,7 +2731,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.primenu(n)[source]
        +sympy.ntheory.factor_.primenu(n)[source]

        Calculate the number of distinct prime factors for a positive integer n.

        Deprecated since version 1.13: The primenu function is deprecated. Use sympy.functions.combinatorial.numbers.primenu @@ -2771,7 +2771,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.primeomega(n)[source]
        +sympy.ntheory.factor_.primeomega(n)[source]

        Calculate the number of prime factors counting multiplicities for a positive integer n.

        @@ -2812,7 +2812,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.mersenne_prime_exponent(nth)[source]
        +sympy.ntheory.factor_.mersenne_prime_exponent(nth)[source]

        Returns the exponent i for the nth Mersenne prime (which has the form \(2^i - 1\)).

        Examples

        @@ -2827,7 +2827,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.is_perfect(n)[source]
        +sympy.ntheory.factor_.is_perfect(n)[source]

        Returns True if n is a perfect number, else False.

        A perfect number is equal to the sum of its positive, proper divisors.

        Examples

        @@ -2856,7 +2856,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.abundance(n)[source]
        +sympy.ntheory.factor_.abundance(n)[source]

        Returns the difference between the sum of the positive proper divisors of a number and the number.

        Examples

        @@ -2875,7 +2875,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.is_abundant(n)[source]
        +sympy.ntheory.factor_.is_abundant(n)[source]

        Returns True if n is an abundant number, else False.

        A abundant number is smaller than the sum of its positive proper divisors.

        Examples

        @@ -2897,7 +2897,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.is_deficient(n)[source]
        +sympy.ntheory.factor_.is_deficient(n)[source]

        Returns True if n is a deficient number, else False.

        A deficient number is greater than the sum of its positive proper divisors.

        Examples

        @@ -2919,7 +2919,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.is_amicable(m, n)[source]
        +sympy.ntheory.factor_.is_amicable(m, n)[source]

        Returns True if the numbers \(m\) and \(n\) are “amicable”, else False.

        Amicable numbers are two different numbers so related that the sum of the proper divisors of each is equal to that of the other.

        @@ -2943,7 +2943,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.is_carmichael(n)[source]
        +sympy.ntheory.factor_.is_carmichael(n)[source]

        Returns True if the numbers \(n\) is Carmichael number, else False.

        Parameters:
        @@ -2965,7 +2965,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.find_carmichael_numbers_in_range(x, y)[source]
        +sympy.ntheory.factor_.find_carmichael_numbers_in_range(x, y)[source]

        Returns a list of the number of Carmichael in the range

        See also

        @@ -2975,7 +2975,7 @@

        Ntheory Class Reference
        -sympy.ntheory.factor_.find_first_n_carmichaels(n)[source]
        +sympy.ntheory.factor_.find_first_n_carmichaels(n)[source]

        Returns the first n Carmichael numbers.

        Parameters:
        @@ -2990,7 +2990,7 @@

        Ntheory Class Reference
        -sympy.ntheory.modular.symmetric_residue(a, m)[source]
        +sympy.ntheory.modular.symmetric_residue(a, m)[source]

        Return the residual mod m such that it is within half of the modulus.

        >>> from sympy.ntheory.modular import symmetric_residue
         >>> symmetric_residue(1, 6)
        @@ -3003,7 +3003,7 @@ 

        Ntheory Class Reference
        -sympy.ntheory.modular.crt(m, v, symmetric=False, check=True)[source]
        +sympy.ntheory.modular.crt(m, v, symmetric=False, check=True)[source]

        Chinese Remainder Theorem.

        The moduli in m are assumed to be pairwise coprime. The output is then an integer f, such that f = v_i mod m_i for each pair out @@ -3059,7 +3059,7 @@

        Ntheory Class Reference
        -sympy.ntheory.modular.crt1(m)[source]
        +sympy.ntheory.modular.crt1(m)[source]

        First part of Chinese Remainder Theorem, for multiple application.

        Examples

        >>> from sympy.ntheory.modular import crt, crt1, crt2
        @@ -3099,7 +3099,7 @@ 

        Ntheory Class Reference
        -sympy.ntheory.modular.crt2(m, v, mm, e, s, symmetric=False)[source]
        +sympy.ntheory.modular.crt2(m, v, mm, e, s, symmetric=False)[source]

        Second part of Chinese Remainder Theorem, for multiple application.

        See crt1 for usage.

        Examples

        @@ -3121,7 +3121,7 @@

        Ntheory Class Reference
        -sympy.ntheory.modular.solve_congruence(*remainder_modulus_pairs, **hint)[source]
        +sympy.ntheory.modular.solve_congruence(*remainder_modulus_pairs, **hint)[source]

        Compute the integer n that has the residual ai when it is divided by mi where the ai and mi are given as pairs to this function: ((a1, m1), (a2, m2), …). If there is no solution, @@ -3175,7 +3175,7 @@

        Ntheory Class Reference
        -sympy.ntheory.multinomial.binomial_coefficients(n)[source]
        +sympy.ntheory.multinomial.binomial_coefficients(n)[source]

        Return a dictionary containing pairs \({(k1,k2) : C_kn}\) where \(C_kn\) are binomial coefficients and \(n=k1+k2\).

        Examples

        @@ -3193,7 +3193,7 @@

        Ntheory Class Reference
        -sympy.ntheory.multinomial.binomial_coefficients_list(n)[source]
        +sympy.ntheory.multinomial.binomial_coefficients_list(n)[source]

        Return a list of binomial coefficients as rows of the Pascal’s triangle.

        Examples

        @@ -3210,7 +3210,7 @@

        Ntheory Class Reference
        -sympy.ntheory.multinomial.multinomial_coefficients(m, n)[source]
        +sympy.ntheory.multinomial.multinomial_coefficients(m, n)[source]

        Return a dictionary containing pairs {(k1,k2,..,km) : C_kn} where C_kn are multinomial coefficients such that n=k1+k2+..+km.

        @@ -3245,7 +3245,7 @@

        Ntheory Class Reference_tuple=<class 'tuple'>,

        -)[source] +)[source]

        multinomial coefficient iterator

        This routine has been optimized for \(m\) large with respect to \(n\) by taking advantage of the fact that when the monomial tuples \(t\) are stripped of @@ -3269,7 +3269,7 @@

        Ntheory Class Reference
        -sympy.ntheory.partitions_.npartitions(n, verbose=False)[source]
        +sympy.ntheory.partitions_.npartitions(n, verbose=False)[source]

        Calculate the partition function P(n), i.e. the number of ways that n can be written as a sum of positive integers.

        @@ -3297,7 +3297,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_fermat_pseudoprime(n, a)[source]
        +sympy.ntheory.primetest.is_fermat_pseudoprime(n, a)[source]

        Returns True if n is prime or is an odd composite integer that is coprime to a and satisfy the modular arithmetic congruence relation:

        @@ -3346,7 +3346,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_euler_pseudoprime(n, a)[source]
        +sympy.ntheory.primetest.is_euler_pseudoprime(n, a)[source]

        Returns True if n is prime or is an odd composite integer that is coprime to a and satisfy the modular arithmetic congruence relation:

        @@ -3394,7 +3394,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_euler_jacobi_pseudoprime(n, a)[source]
        +sympy.ntheory.primetest.is_euler_jacobi_pseudoprime(n, a)[source]

        Returns True if n is prime or is an odd composite integer that is coprime to a and satisfy the modular arithmetic congruence relation:

        @@ -3441,7 +3441,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_square(n, prep=True)[source]
        +sympy.ntheory.primetest.is_square(n, prep=True)[source]

        Return True if n == a * a for some integer a, else False. If n is suspected of not being a square then this is a quick method of confirming that it is not.

        @@ -3468,7 +3468,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.mr(n, bases)[source]
        +sympy.ntheory.primetest.mr(n, bases)[source]

        Perform a Miller-Rabin strong pseudoprime test on n using a given list of bases/witnesses.

        Examples

        @@ -3493,7 +3493,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_lucas_prp(n)[source]
        +sympy.ntheory.primetest.is_lucas_prp(n)[source]

        Standard Lucas compositeness test with Selfridge parameters. Returns False if n is definitely composite, and True if n is a Lucas probable prime.

        @@ -3537,7 +3537,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_strong_lucas_prp(n)[source]
        +sympy.ntheory.primetest.is_strong_lucas_prp(n)[source]

        Strong Lucas compositeness test with Selfridge parameters. Returns False if n is definitely composite, and True if n is a strong Lucas probable prime.

        @@ -3582,7 +3582,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_extra_strong_lucas_prp(n)[source]
        +sympy.ntheory.primetest.is_extra_strong_lucas_prp(n)[source]

        Extra Strong Lucas compositeness test. Returns False if n is definitely composite, and True if n is an “extra strong” Lucas probable prime.

        @@ -3629,7 +3629,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.proth_test(n)[source]
        +sympy.ntheory.primetest.proth_test(n)[source]

        Test if the Proth number \(n = k2^m + 1\) is prime. where k is a positive odd number and \(2^m > k\).

        Parameters:
        @@ -3667,7 +3667,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_mersenne_prime(n)[source]
        +sympy.ntheory.primetest.is_mersenne_prime(n)[source]

        Returns True if n is a Mersenne prime, else False.

        A Mersenne prime is a prime number having the form \(2^i - 1\).

        Examples

        @@ -3689,7 +3689,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.isprime(n)[source]
        +sympy.ntheory.primetest.isprime(n)[source]

        Test if n is a prime number (True) or not (False). For n < 2^64 the answer is definitive; larger n values have a small probability of actually being pseudoprimes.

        @@ -3769,7 +3769,7 @@

        Ntheory Class Reference
        -sympy.ntheory.primetest.is_gaussian_prime(num)[source]
        +sympy.ntheory.primetest.is_gaussian_prime(num)[source]

        Test if num is a Gaussian prime number.

        References

        @@ -3782,7 +3782,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.n_order(a, n)[source]
        +sympy.ntheory.residue_ntheory.n_order(a, n)[source]

        Returns the order of a modulo n.

        Parameters:
        @@ -3822,7 +3822,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.is_primitive_root(a, p)[source]
        +sympy.ntheory.residue_ntheory.is_primitive_root(a, p)[source]

        Returns True if a is a primitive root of p.

        Parameters:
        @@ -3874,7 +3874,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.primitive_root(p, smallest=True)[source]
        +sympy.ntheory.residue_ntheory.primitive_root(p, smallest=True)[source]

        Returns a primitive root of p or None.

        Parameters:
        @@ -3941,7 +3941,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.sqrt_mod(a, p, all_roots=False)[source]
        +sympy.ntheory.residue_ntheory.sqrt_mod(a, p, all_roots=False)[source]

        Find a root of x**2 = a mod p.

        Parameters:
        @@ -3968,7 +3968,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.sqrt_mod_iter(a, p, domain=<class 'int'>)[source]
        +sympy.ntheory.residue_ntheory.sqrt_mod_iter(a, p, domain=<class 'int'>)[source]

        Iterate over solutions to x**2 = a mod p.

        Parameters:
        @@ -3994,7 +3994,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.quadratic_residues(p) list[int][source]
        +sympy.ntheory.residue_ntheory.quadratic_residues(p) list[int][source]

        Returns the list of quadratic residues.

        Examples

        >>> from sympy.ntheory.residue_ntheory import quadratic_residues
        @@ -4006,7 +4006,7 @@ 

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.nthroot_mod(a, n, p, all_roots=False)[source]
        +sympy.ntheory.residue_ntheory.nthroot_mod(a, n, p, all_roots=False)[source]

        Find the solutions to x**n = a mod p.

        Parameters:
        @@ -4081,7 +4081,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.is_nthpow_residue(a, n, m)[source]
        +sympy.ntheory.residue_ntheory.is_nthpow_residue(a, n, m)[source]

        Returns True if x**n == a (mod m) has solutions.

        References

        @@ -4096,7 +4096,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.is_quad_residue(a, p)[source]
        +sympy.ntheory.residue_ntheory.is_quad_residue(a, p)[source]

        Returns True if a (mod p) is in the set of squares mod p, i.e a % p in set([i**2 % p for i in range(p)]).

        @@ -4144,7 +4144,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.legendre_symbol(a, p)[source]
        +sympy.ntheory.residue_ntheory.legendre_symbol(a, p)[source]

        Returns the Legendre symbol \((a / p)\).

        Deprecated since version 1.13: The legendre_symbol function is deprecated. Use sympy.functions.combinatorial.numbers.legendre_symbol @@ -4183,7 +4183,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.jacobi_symbol(m, n)[source]
        +sympy.ntheory.residue_ntheory.jacobi_symbol(m, n)[source]

        Returns the Jacobi symbol \((m / n)\).

        Deprecated since version 1.13: The jacobi_symbol function is deprecated. Use sympy.functions.combinatorial.numbers.jacobi_symbol @@ -4243,7 +4243,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.mobius(n)[source]
        +sympy.ntheory.residue_ntheory.mobius(n)[source]

        Mobius function maps natural number to {-1, 0, 1}

        Deprecated since version 1.13: The mobius function is deprecated. Use sympy.functions.combinatorial.numbers.mobius @@ -4305,7 +4305,7 @@

        Ntheory Class Referenceprime_order=None,

        -)[source] +)[source]

        Compute the discrete logarithm of a to the base b modulo n.

        This is a recursive function to reduce the discrete logarithm problem in cyclic groups of composite order to the problem in cyclic groups of prime @@ -4343,7 +4343,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.quadratic_congruence(a, b, c, n)[source]
        +sympy.ntheory.residue_ntheory.quadratic_congruence(a, b, c, n)[source]

        Find the solutions to \(a x^2 + b x + c \equiv 0 \pmod{n}\).

        Parameters:
        @@ -4381,7 +4381,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.polynomial_congruence(expr, m)[source]
        +sympy.ntheory.residue_ntheory.polynomial_congruence(expr, m)[source]

        Find the solutions to a polynomial congruence equation modulo m.

        Parameters:
        @@ -4408,7 +4408,7 @@

        Ntheory Class Reference
        -sympy.ntheory.residue_ntheory.binomial_mod(n, m, k)[source]
        +sympy.ntheory.residue_ntheory.binomial_mod(n, m, k)[source]

        Compute binomial(n, m) % k.

        Parameters:
        @@ -4443,7 +4443,7 @@

        Ntheory Class Reference
        -sympy.ntheory.continued_fraction.continued_fraction(a) list[source]
        +sympy.ntheory.continued_fraction.continued_fraction(a) list[source]

        Return the continued fraction representation of a Rational or quadratic irrational.

        Examples

        @@ -4461,7 +4461,7 @@

        Ntheory Class Reference
        -sympy.ntheory.continued_fraction.continued_fraction_convergents(cf)[source]
        +sympy.ntheory.continued_fraction.continued_fraction_convergents(cf)[source]

        Return an iterator over the convergents of a continued fraction (cf).

        The parameter should be in either of the following to forms: - A list of partial quotients, possibly with the last element being a list @@ -4518,7 +4518,7 @@

        Ntheory Class Reference
        -sympy.ntheory.continued_fraction.continued_fraction_iterator(x)[source]
        +sympy.ntheory.continued_fraction.continued_fraction_iterator(x)[source]

        Return continued fraction expansion of x as iterator.

        Examples

        >>> from sympy import Rational, pi
        @@ -4565,7 +4565,7 @@ 

        Ntheory Class References=1,

        -) list[source] +) list[source]

        Find the periodic continued fraction expansion of a quadratic irrational.

        Compute the continued fraction expansion of a rational or a quadratic irrational number, i.e. \(\frac{p + s\sqrt{d}}{q}\), where @@ -4632,7 +4632,7 @@

        Ntheory Class Reference
        -sympy.ntheory.continued_fraction.continued_fraction_reduce(cf)[source]
        +sympy.ntheory.continued_fraction.continued_fraction_reduce(cf)[source]

        Reduce a continued fraction to a rational or quadratic irrational.

        Compute the rational or quadratic irrational number from its terminating or periodic continued fraction expansion. The @@ -4672,7 +4672,7 @@

        Ntheory Class Reference
        -sympy.ntheory.digits.count_digits(n, b=10)[source]
        +sympy.ntheory.digits.count_digits(n, b=10)[source]

        Return a dictionary whose keys are the digits of n in the given base, b, with keys indicating the digits appearing in the number and values indicating how many times that digit appeared.

        @@ -4713,7 +4713,7 @@

        Ntheory Class Reference
        -sympy.ntheory.digits.digits(n, b=10, digits=None)[source]
        +sympy.ntheory.digits.digits(n, b=10, digits=None)[source]

        Return a list of the digits of n in base b. The first element in the list is b (or -b if n is negative).

        @@ -4763,7 +4763,7 @@

        Ntheory Class Reference
        -sympy.ntheory.digits.is_palindromic(n, b=10)[source]
        +sympy.ntheory.digits.is_palindromic(n, b=10)[source]

        return True if n is the same when read from left to right or right to left in the given base, b.

        Examples

        @@ -4796,7 +4796,7 @@

        Ntheory Class Reference
        -sympy.ntheory.egyptian_fraction.egyptian_fraction(r, algorithm='Greedy')[source]
        +sympy.ntheory.egyptian_fraction.egyptian_fraction(r, algorithm='Greedy')[source]

        Return the list of denominators of an Egyptian fraction expansion [R713] of the said rational \(r\).

        @@ -4903,7 +4903,7 @@

        Ntheory Class Reference
        -sympy.ntheory.bbp_pi.pi_hex_digits(n, prec=14)[source]
        +sympy.ntheory.bbp_pi.pi_hex_digits(n, prec=14)[source]

        Returns a string containing prec (default 14) digits starting at the nth digit of pi in hex. Counting of digits starts at 0 and the decimal is not counted, so for n = 0 the @@ -4977,7 +4977,7 @@

        Ntheory Class Referenceseed=1234,

        -)[source] +)[source]

        Performs factorization using Lenstra’s Elliptic curve method.

        This function repeatedly calls _ecm_one_factor to compute the factors of n. First all the small factors are taken out using trial division. @@ -5028,7 +5028,7 @@

        Examples with two 25 digit factors. \(qs\) is able to factorize this in around 248s.

        -sympy.ntheory.qs.qs(N, prime_bound, M, ERROR_TERM=25, seed=1234)[source]
        +sympy.ntheory.qs.qs(N, prime_bound, M, ERROR_TERM=25, seed=1234)[source]

        Performs factorization using Self-Initializing Quadratic Sieve. In SIQS, let N be a number to be factored, and this N should not be a perfect power. If we find two integers such that X**2 = Y**2 modN and diff --git a/dev/modules/parsing.html b/dev/modules/parsing.html index c48b5d5d7e8..ce1149a03d2 100644 --- a/dev/modules/parsing.html +++ b/dev/modules/parsing.html @@ -807,7 +807,7 @@

        Documentation Version

        Parsing Functions Reference

        -sympy.parsing.sympy_parser.parse_expr(s: str, local_dict: ~typing.Dict[str, ~typing.Any] | None = None, transformations: ~typing.Tuple[~typing.Callable[[~typing.List[~typing.Tuple[int, str]], ~typing.Dict[str, ~typing.Any], ~typing.Dict[str, ~typing.Any]], ~typing.List[~typing.Tuple[int, str]]], ...] | str = (<function lambda_notation>, <function auto_symbol>, <function repeated_decimals>, <function auto_number>, <function factorial_notation>), global_dict: ~typing.Dict[str, ~typing.Any] | None = None, evaluate=True)[source]
        +sympy.parsing.sympy_parser.parse_expr(s: str, local_dict: ~typing.Dict[str, ~typing.Any] | None = None, transformations: ~typing.Tuple[~typing.Callable[[~typing.List[~typing.Tuple[int, str]], ~typing.Dict[str, ~typing.Any], ~typing.Dict[str, ~typing.Any]], ~typing.List[~typing.Tuple[int, str]]], ...] | str = (<function lambda_notation>, <function auto_symbol>, <function repeated_decimals>, <function auto_number>, <function factorial_notation>), global_dict: ~typing.Dict[str, ~typing.Any] | None = None, evaluate=True)[source]

        Converts the string s to a SymPy expression, in local_dict.

        Parameters:
        @@ -947,7 +947,7 @@

        Parsing Functions Referencetransformations: Tuple[Callable[[List[Tuple[int, str]], Dict[str, Any], Dict[str, Any]], List[Tuple[int, str]]], ...],

        -) str[source] +) str[source]

        Converts the string s to Python code, in local_dict

        Generally, parse_expr should be used.

        @@ -962,19 +962,19 @@

        Parsing Functions Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Evaluate Python code generated by stringify_expr.

        Generally, parse_expr should be used.

        -sympy.parsing.maxima.parse_maxima(str, globals=None, name_dict={})[source]
        +sympy.parsing.maxima.parse_maxima(str, globals=None, name_dict={})[source]
        -sympy.parsing.mathematica.parse_mathematica(s)[source]
        +sympy.parsing.mathematica.parse_mathematica(s)[source]

        Translate a string containing a Wolfram Mathematica expression to a SymPy expression.

        If the translator is unable to find a suitable SymPy expression, the @@ -1047,7 +1047,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Splits symbol names for implicit multiplication.

        Intended to let expressions like xyz be parsed as x*y*z. Does not split Greek character names, so theta will not become @@ -1063,7 +1063,7 @@

        Parsing Transformations Referencepredicate: Callable[[str], bool],

        -)[source] +)[source]

        Creates a transformation that splits symbol names.

        predicate should return True if the symbol name is to be split.

        For instance, to retain the default behavior but avoid splitting certain @@ -1094,7 +1094,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -) List[Tuple[int, str]][source] +) List[Tuple[int, str]][source]

        Makes the multiplication operator optional in most cases.

        Use this before implicit_application(), otherwise expressions like sin 2x will be parsed as x * sin(2) rather than sin(2*x).

        @@ -1118,7 +1118,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -) List[Tuple[int, str]][source] +) List[Tuple[int, str]][source]

        Makes parentheses optional in some cases for function calls.

        Use this after implicit_multiplication(), otherwise expressions like sin 2x will be parsed as x * sin(2) rather than @@ -1143,7 +1143,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Allows functions to be exponentiated, e.g. cos**2(x).

        Examples

        >>> from sympy.parsing.sympy_parser import (parse_expr,
        @@ -1165,7 +1165,7 @@ 

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -) List[Tuple[int, str]][source] +) List[Tuple[int, str]][source]

        Allows a slightly relaxed syntax.

        • Parentheses for single-argument method calls are optional.

        • @@ -1195,7 +1195,7 @@

          Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Converts floats into Rational. Run AFTER auto_number.

        @@ -1209,7 +1209,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Treats XOR, ^, as exponentiation, **.

        @@ -1226,7 +1226,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Substitutes “lambda” with its SymPy equivalent Lambda(). However, the conversion does not take place if only “lambda” is passed because that is a syntax error.

        @@ -1242,7 +1242,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Inserts calls to Symbol/Function for undefined variables.

        @@ -1256,7 +1256,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Allows 0.2[1] notation to represent the repeated decimal 0.2111… (19/90)

        Run this before auto_number.

        @@ -1271,7 +1271,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Converts numeric literals to use SymPy equivalents.

        Complex numbers use I, integer literals use Integer, and float literals use Float.

        @@ -1287,7 +1287,7 @@

        Parsing Transformations Referenceglobal_dict: Dict[str, Any],

        -)[source] +)[source]

        Allows standard notation for factorial.

        @@ -1303,7 +1303,7 @@

        Experimental \(\mathrm{\LaTeX}\)<

        \(\mathrm{\LaTeX}\) Parsing Functions Reference

        -sympy.parsing.latex.parse_latex(s, strict=False, backend='antlr')[source]
        +sympy.parsing.latex.parse_latex(s, strict=False, backend='antlr')[source]

        Converts the input LaTeX string s to a SymPy Expr.

        Parameters:
        @@ -1477,7 +1477,7 @@

        Lark \(\mathrm{\LaTeX}\) P

        Lark \(\mathrm{\LaTeX}\) Parser Functions

        -sympy.parsing.latex.parse_latex_lark(s: str)[source]
        +sympy.parsing.latex.parse_latex_lark(s: str)[source]

        Experimental LaTeX parser using Lark.

        This function is still under development and its API may change with the next releases of SymPy.

        @@ -1497,7 +1497,7 @@

        Lark \(\mathrm{\LaTeX}\) P
        transformer=None,

        -)[source] +)[source]

        Class for converting input \(\mathrm{\LaTeX}\) strings into SymPy Expressions. It holds all the necessary internal data for doing so, and exposes hooks for customizing its behavior.

        @@ -1530,7 +1530,7 @@

        Lark \(\mathrm{\LaTeX}\) P
        -class sympy.parsing.latex.lark.TransformToSymPyExpr[source]
        +class sympy.parsing.latex.lark.TransformToSymPyExpr[source]

        Returns a SymPy expression that is generated by traversing the lark.Tree passed to the .transform() function.

        @@ -1557,7 +1557,7 @@

        Lark \(\mathrm{\LaTeX}\) P

        \(\mathrm{\LaTeX}\) Parsing Exceptions Reference

        -class sympy.parsing.latex.LaTeXParsingError[source]
        +class sympy.parsing.latex.LaTeXParsingError[source]
        @@ -1565,7 +1565,7 @@

        \(\mathrm{\LaTeX}\) Parsin

        SymPy Expression Reference

        -class sympy.parsing.sym_expr.SymPyExpression(source_code=None, mode=None)[source]
        +class sympy.parsing.sym_expr.SymPyExpression(source_code=None, mode=None)[source]

        Class to store and handle SymPy expressions

        This class will hold SymPy Expressions and handle the API for the conversion to and from different languages.

        @@ -1636,7 +1636,7 @@

        \(\mathrm{\LaTeX}\) Parsin

        -convert_to_c()[source]
        +convert_to_c()[source]

        Returns a list with the c source code for the SymPy expressions

        Examples

        >>> from sympy.parsing.sym_expr import SymPyExpression
        @@ -1658,7 +1658,7 @@ 

        \(\mathrm{\LaTeX}\) Parsin
        -convert_to_expr(src_code, mode)[source]
        +convert_to_expr(src_code, mode)[source]

        Converts the given source code to SymPy Expressions

        Examples

        >>> from sympy.parsing.sym_expr import SymPyExpression
        @@ -1697,7 +1697,7 @@ 

        \(\mathrm{\LaTeX}\) Parsin
        -convert_to_fortran()[source]
        +convert_to_fortran()[source]

        Returns a list with the fortran source code for the SymPy expressions

        Examples

        >>> from sympy.parsing.sym_expr import SymPyExpression
        @@ -1718,7 +1718,7 @@ 

        \(\mathrm{\LaTeX}\) Parsin
        -convert_to_python()[source]
        +convert_to_python()[source]

        Returns a list with Python code for the SymPy expressions

        Examples

        >>> from sympy.parsing.sym_expr import SymPyExpression
        @@ -1739,7 +1739,7 @@ 

        \(\mathrm{\LaTeX}\) Parsin
        -return_expr()[source]
        +return_expr()[source]

        Returns the expression list

        Examples

        >>> from sympy.parsing.sym_expr import SymPyExpression
        diff --git a/dev/modules/physics/biomechanics/api/activation.html b/dev/modules/physics/biomechanics/api/activation.html
        index efd502faa36..f3c87532c50 100644
        --- a/dev/modules/physics/biomechanics/api/activation.html
        +++ b/dev/modules/physics/biomechanics/api/activation.html
        @@ -814,7 +814,7 @@ 
        Documentation Version
        module.

        -class sympy.physics.biomechanics.activation.ActivationBase(name)[source]
        +class sympy.physics.biomechanics.activation.ActivationBase(name)[source]

        Abstract base class for all activation dynamics classes to inherit from.

        Notes

        Instances of this class cannot be directly instantiated by users. However, @@ -928,7 +928,7 @@

        Documentation Version
        -abstract rhs()[source]
        +abstract rhs()[source]

        Explanation

        The solution to the linear system of ordinary differential equations governing the activation dynamics:

        @@ -946,7 +946,7 @@
        Documentation Version
        -abstract classmethod with_defaults(name)[source]
        +abstract classmethod with_defaults(name)[source]

        Alternate constructor that provides recommended defaults for constants.

        @@ -973,7 +973,7 @@
        Documentation Version
        smoothing_rate=None,
        -)[source] +)[source]

        First-order activation dynamics based on De Groote et al., 2016 [R720].

        Explanation

        Gives the first-order activation dynamics equation for the rate of change @@ -1106,7 +1106,7 @@

        Documentation Version
        -rhs()[source]
        +rhs()[source]

        Ordered column matrix of equations for the solution of M x' = F.

        Explanation

        The solution to the linear system of ordinary differential equations @@ -1157,7 +1157,7 @@

        Documentation Version
        name,
        -)[source] +)[source]

        Alternate constructor that will use the published constants.

        Explanation

        Returns an instance of FirstOrderActivationDeGroote2016 using the @@ -1181,7 +1181,7 @@

        Documentation Version
        -class sympy.physics.biomechanics.activation.ZerothOrderActivation(name)[source]
        +class sympy.physics.biomechanics.activation.ZerothOrderActivation(name)[source]

        Simple zeroth-order activation dynamics mapping excitation to activation.

        Explanation

        @@ -1285,7 +1285,7 @@
        Documentation Version
        -rhs()[source]
        +rhs()[source]

        Ordered column matrix of equations for the solution of M x' = F.

        Explanation

        The solution to the linear system of ordinary differential equations @@ -1310,7 +1310,7 @@

        Documentation Version
        -classmethod with_defaults(name)[source]
        +classmethod with_defaults(name)[source]

        Alternate constructor that provides recommended defaults for constants.

        Explanation

        diff --git a/dev/modules/physics/biomechanics/api/curve.html b/dev/modules/physics/biomechanics/api/curve.html index 5f0e48741c6..71a07b5fcdb 100644 --- a/dev/modules/physics/biomechanics/api/curve.html +++ b/dev/modules/physics/biomechanics/api/curve.html @@ -818,13 +818,13 @@
        Documentation Version
        fiber_force_velocity_inverse: CharacteristicCurveFunction,
        -)[source] +)[source]

        Simple data container to group together related characteristic curves.

        -class sympy.physics.biomechanics.curve.CharacteristicCurveFunction[source]
        +class sympy.physics.biomechanics.curve.CharacteristicCurveFunction[source]

        Base class for all musculotendon characteristic curve functions.

        @@ -848,7 +848,7 @@
        Documentation Version
        c11,
        -)[source] +)[source]

        Active muscle fiber force-length curve based on De Groote et al., 2016 [R721].

        Explanation

        @@ -951,7 +951,7 @@
        Documentation Version
        **hints,
        -)[source] +)[source]

        Evaluate the expression defining the function.

        Parameters:
        @@ -996,7 +996,7 @@
        Documentation Version
        c11,
        -)[source] +)[source]

        Evaluation of basic inputs.

        Parameters:
        @@ -1076,7 +1076,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Derivative of the function with respect to a single argument.

        Parameters:
        @@ -1098,7 +1098,7 @@
        Documentation Version
        l_M_tilde,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        @@ -1140,7 +1140,7 @@
        Documentation Version
        c1,
        -)[source] +)[source]

        Passive muscle fiber force-length curve based on De Groote et al., 2016 [R722].

        Explanation

        @@ -1223,7 +1223,7 @@
        Documentation Version
        **hints,
        -)[source] +)[source]

        Evaluate the expression defining the function.

        Parameters:
        @@ -1258,7 +1258,7 @@
        Documentation Version
        c1,
        -)[source] +)[source]

        Evaluation of basic inputs.

        Parameters:
        @@ -1288,7 +1288,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Derivative of the function with respect to a single argument.

        Parameters:
        @@ -1310,7 +1310,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Inverse function.

        Parameters:
        @@ -1330,7 +1330,7 @@
        Documentation Version
        l_M_tilde,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        @@ -1361,7 +1361,7 @@
        Documentation Version
        c1,
        -)[source] +)[source]

        Inverse passive muscle fiber force-length curve based on De Groote et al., 2016 [R723].

        Explanation

        @@ -1438,7 +1438,7 @@
        Documentation Version
        **hints,

        -)[source] +)[source]

        Evaluate the expression defining the function.

        Parameters:
        @@ -1473,7 +1473,7 @@
        Documentation Version
        c1,
        -)[source] +)[source]

        Evaluation of basic inputs.

        Parameters:
        @@ -1503,7 +1503,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Derivative of the function with respect to a single argument.

        Parameters:
        @@ -1525,7 +1525,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Inverse function.

        Parameters:
        @@ -1545,7 +1545,7 @@
        Documentation Version
        fl_M_pas,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        @@ -1579,7 +1579,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Muscle fiber force-velocity curve based on De Groote et al., 2016 [R724].

        Explanation

        Gives the normalized muscle fiber force produced as a function of @@ -1665,7 +1665,7 @@

        Documentation Version
        **hints,

        -)[source] +)[source]

        Evaluate the expression defining the function.

        Parameters:
        @@ -1702,7 +1702,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Evaluation of basic inputs.

        Parameters:
        @@ -1736,7 +1736,7 @@
        Documentation Version
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Derivative of the function with respect to a single argument.

        Parameters:
        @@ -1752,7 +1752,7 @@
        Documentation Version
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Inverse function.

        Parameters:
        @@ -1772,7 +1772,7 @@
        Documentation Version
        v_M_tilde,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        @@ -1806,7 +1806,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Inverse muscle fiber force-velocity curve based on De Groote et al., 2016 [R725].

        Explanation

        @@ -1882,7 +1882,7 @@
        Documentation Version
        **hints,
        -)[source] +)[source]

        Evaluate the expression defining the function.

        Parameters:
        @@ -1919,7 +1919,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Evaluation of basic inputs.

        Parameters:
        @@ -1960,7 +1960,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Derivative of the function with respect to a single argument.

        Parameters:
        @@ -1982,7 +1982,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Inverse function.

        Parameters:
        @@ -2002,7 +2002,7 @@
        Documentation Version
        fv_M,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        @@ -2037,7 +2037,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Tendon force-length curve based on De Groote et al., 2016 [R726].

        Explanation

        Gives the normalized tendon force produced as a function of normalized @@ -2124,7 +2124,7 @@

        Documentation Version
        **hints,
        -)[source] +)[source]

        Evaluate the expression defining the function.

        Parameters:
        @@ -2161,7 +2161,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Evaluation of basic inputs.

        Parameters:
        @@ -2195,7 +2195,7 @@
        Documentation Version
        -fdiff(argindex=1)[source]
        +fdiff(argindex=1)[source]

        Derivative of the function with respect to a single argument.

        Parameters:
        @@ -2211,7 +2211,7 @@
        Documentation Version
        -inverse(argindex=1)[source]
        +inverse(argindex=1)[source]

        Inverse function.

        Parameters:
        @@ -2231,7 +2231,7 @@
        Documentation Version
        l_T_tilde,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        @@ -2265,7 +2265,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Inverse tendon force-length curve based on De Groote et al., 2016 [R727].

        Explanation

        Gives the normalized tendon length that produces a specific normalized @@ -2341,7 +2341,7 @@

        Documentation Version
        **hints,
        -)[source] +)[source]

        Evaluate the expression defining the function.

        Parameters:
        @@ -2378,7 +2378,7 @@
        Documentation Version
        c3,
        -)[source] +)[source]

        Evaluation of basic inputs.

        Parameters:
        @@ -2418,7 +2418,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Derivative of the function with respect to a single argument.

        Parameters:
        @@ -2440,7 +2440,7 @@
        Documentation Version
        argindex=1,
        -)[source] +)[source]

        Inverse function.

        Parameters:
        @@ -2460,7 +2460,7 @@
        Documentation Version
        fl_T,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        diff --git a/dev/modules/physics/biomechanics/api/musculotendon.html b/dev/modules/physics/biomechanics/api/musculotendon.html index 3fef9f0b165..d75d0a7d058 100644 --- a/dev/modules/physics/biomechanics/api/musculotendon.html +++ b/dev/modules/physics/biomechanics/api/musculotendon.html @@ -830,7 +830,7 @@
        Documentation Version
        with_defaults=False,
        -)[source] +)[source]

        Abstract base class for all musculotendon classes to inherit from.

        Parameters:
        @@ -1035,7 +1035,7 @@
        Documentation Version
        -abstract curves()[source]
        +abstract curves()[source]

        Return a CharacteristicCurveCollection of the curves related to the specific model.

        @@ -1204,7 +1204,7 @@
        Documentation Version
        -rhs()[source]
        +rhs()[source]

        Ordered column matrix of equations for the solution of M x' = F.

        Explanation

        The solution to the linear system of ordinary differential equations @@ -1268,7 +1268,7 @@

        Documentation Version
        fiber_damping_coefficient=0.100000000000000,
        -)[source] +)[source]

        Recommended constructor that will use the published constants.

        Parameters:
        @@ -1399,7 +1399,7 @@
        Documentation Version
        with_defaults=False,
        -)[source] +)[source]

        Musculotendon model using the curves of De Groote et al., 2016 [R728].

        Parameters:
        @@ -1787,7 +1787,7 @@
        Documentation Version
        boundary=None,
        -)[source] +)[source]

        Enumeration of types of musculotendon dynamics formulations.

        Explanation

        An (integer) enumeration is used as it allows for clearer selection of the diff --git a/dev/modules/physics/continuum_mechanics/beam.html b/dev/modules/physics/continuum_mechanics/beam.html index c76b68de8f1..df22e4f3a0b 100644 --- a/dev/modules/physics/continuum_mechanics/beam.html +++ b/dev/modules/physics/continuum_mechanics/beam.html @@ -819,7 +819,7 @@

        Documentation Version
        ild_variable=a,
        -)[source] +)[source]

        A Beam is a structural element that is capable of withstanding load primarily by resisting against bending. Beams are characterized by their cross sectional profile(Second moment of area), their length @@ -936,7 +936,7 @@

        Documentation Version
        -apply_load(value, start, order, end=None)[source]
        +apply_load(value, start, order, end=None)[source]

        This method adds up the loads given to a particular beam object.

        Parameters:
        @@ -1004,7 +1004,7 @@
        Documentation Version
        -apply_rotation_hinge(loc)[source]
        +apply_rotation_hinge(loc)[source]

        This method applies a rotation hinge at a single location on the beam.

        Parameters:
        @@ -1058,7 +1058,7 @@
        Documentation Version
        -apply_sliding_hinge(loc)[source]
        +apply_sliding_hinge(loc)[source]

        This method applies a sliding hinge at a single location on the beam.

        Parameters:
        @@ -1105,7 +1105,7 @@
        Documentation Version
        -apply_support(loc, type='fixed')[source]
        +apply_support(loc, type='fixed')[source]

        This method applies support to a particular beam object and returns the symbol of the unknown reaction load(s).

        @@ -1168,7 +1168,7 @@
        Documentation Version
        -bending_moment()[source]
        +bending_moment()[source]

        Returns a Singularity Function expression which represents the bending moment curve of the Beam object.

        Examples

        @@ -1231,7 +1231,7 @@
        Documentation Version
        -deflection()[source]
        +deflection()[source]

        Returns a Singularity Function expression which represents the elastic curve or deflection of the Beam object.

        Examples

        @@ -1271,7 +1271,7 @@
        Documentation Version
        -draw(pictorial=True)[source]
        +draw(pictorial=True)[source]

        Returns a plot object representing the beam diagram of the beam. In particular, the diagram might include:

          @@ -1386,7 +1386,7 @@
          Documentation Version
          -join(beam, via='fixed')[source]
          +join(beam, via='fixed')[source]

          This method joins two beams to make a new composite beam system. Passed Beam class instance is attached to the right end of calling object. This method can be used to form beams having Discontinuous @@ -1466,28 +1466,28 @@

          Documentation Version
          -max_bmoment()[source]
          +max_bmoment()[source]

          Returns maximum Shear force and its coordinate in the Beam object.

          -max_deflection()[source]
          +max_deflection()[source]

          Returns point of max deflection and its corresponding deflection value in a Beam object.

          -max_shear_force()[source]
          +max_shear_force()[source]

          Returns maximum Shear force and its coordinate in the Beam object.

          -plot_bending_moment(subs=None)[source]
          +plot_bending_moment(subs=None)[source]

          Returns a plot for Bending moment present in the Beam object.

          Parameters:
          @@ -1531,7 +1531,7 @@
          Documentation Version
          -plot_deflection(subs=None)[source]
          +plot_deflection(subs=None)[source]

          Returns a plot for deflection curve of the Beam object.

          Parameters:
          @@ -1576,7 +1576,7 @@
          Documentation Version
          -plot_ild_moment(subs=None)[source]
          +plot_ild_moment(subs=None)[source]

          Plots the Influence Line Diagram for Moment under the effect of a moving load. This function should be called after calling solve_for_ild_moment().

          @@ -1626,7 +1626,7 @@
          Documentation Version
          -plot_ild_reactions(subs=None)[source]
          +plot_ild_reactions(subs=None)[source]

          Plots the Influence Line Diagram of Reaction Forces under the effect of a moving load. This function should be called after calling solve_for_ild_reactions().

          @@ -1682,7 +1682,7 @@
          Documentation Version
          -plot_ild_shear(subs=None)[source]
          +plot_ild_shear(subs=None)[source]

          Plots the Influence Line Diagram for Shear under the effect of a moving load. This function should be called after calling solve_for_ild_shear().

          @@ -1732,7 +1732,7 @@
          Documentation Version
          -plot_loading_results(subs=None)[source]
          +plot_loading_results(subs=None)[source]

          Returns a subplot of Shear Force, Bending Moment, Slope and Deflection of the Beam object.

          @@ -1773,7 +1773,7 @@
          Documentation Version
          -plot_shear_force(subs=None)[source]
          +plot_shear_force(subs=None)[source]

          Returns a plot for Shear force present in the Beam object.

          Parameters:
          @@ -1817,7 +1817,7 @@
          Documentation Version
          -plot_shear_stress(subs=None)[source]
          +plot_shear_stress(subs=None)[source]

          Returns a plot of shear stress present in the beam object.

          Parameters:
          @@ -1862,7 +1862,7 @@
          Documentation Version
          -plot_slope(subs=None)[source]
          +plot_slope(subs=None)[source]

          Returns a plot for slope of deflection curve of the Beam object.

          Parameters:
          @@ -1906,7 +1906,7 @@
          Documentation Version
          -point_cflexure()[source]
          +point_cflexure()[source]

          Returns a Set of point(s) with zero bending moment and where bending moment curve of the beam object changes its sign from negative to positive or vice versa.

          @@ -1944,7 +1944,7 @@
          Documentation Version
          -remove_load(value, start, order, end=None)[source]
          +remove_load(value, start, order, end=None)[source]

          This method removes a particular load present on the beam object. Returns a ValueError if the load passed as an argument is not present on the beam.

          @@ -2015,7 +2015,7 @@
          Documentation Version
          -shear_force()[source]
          +shear_force()[source]

          Returns a Singularity Function expression which represents the shear force curve of the Beam object.

          Examples

          @@ -2046,14 +2046,14 @@
          Documentation Version
          -shear_stress()[source]
          +shear_stress()[source]

          Returns an expression representing the Shear Stress curve of the Beam object.

          -slope()[source]
          +slope()[source]

          Returns a Singularity Function expression which represents the slope the elastic curve of the Beam object.

          Examples

          @@ -2093,7 +2093,7 @@
          Documentation Version
          *reactions,
          -)[source] +)[source]

          Determines the Influence Line Diagram equations for moment at a specified point under the effect of a moving load.

          @@ -2141,7 +2141,7 @@
          Documentation Version
          -solve_for_ild_reactions(value, *reactions)[source]
          +solve_for_ild_reactions(value, *reactions)[source]

          Determines the Influence Line Diagram equations for reaction forces under the effect of a moving load.

          @@ -2190,7 +2190,7 @@
          Documentation Version
          *reactions,
          -)[source] +)[source]

          Determines the Influence Line Diagram equations for shear at a specified point under the effect of a moving load.

          @@ -2238,7 +2238,7 @@
          Documentation Version
          -solve_for_reaction_loads(*reactions)[source]
          +solve_for_reaction_loads(*reactions)[source]

          Solves for the reaction forces.

          Examples

          There is a beam of length 30 meters. A moment of magnitude 120 Nm is @@ -2312,7 +2312,7 @@

          Documentation Version
          variable=x,
          -)[source] +)[source]

          This class handles loads applied in any direction of a 3D space along with unequal values of Second moment along different axes.

          @@ -2366,14 +2366,14 @@
          Documentation Version
          -angular_deflection()[source]
          +angular_deflection()[source]

          Returns a function in x depicting how the angular deflection, due to moments in the x-axis on the beam, varies with x.

          -apply_load(value, start, order, dir='y')[source]
          +apply_load(value, start, order, dir='y')[source]

          This method adds up the force load to a particular beam object.

          Parameters:
          @@ -2409,7 +2409,7 @@
          Documentation Version
          dir='y',
          -)[source] +)[source]

          This method adds up the moment loads to a particular beam object.

          Parameters:
          @@ -2442,19 +2442,19 @@
          Documentation Version
          -axial_force()[source]
          +axial_force()[source]

          Returns expression of Axial shear force present inside the Beam object.

          -axial_stress()[source]
          +axial_stress()[source]

          Returns expression of Axial stress present inside the Beam object.

          -bending_moment()[source]
          +bending_moment()[source]

          Returns a list of three expressions which represents the bending moment curve of the Beam object along all three axes.

          @@ -2489,7 +2489,7 @@
          Documentation Version
          -deflection()[source]
          +deflection()[source]

          Returns a three element list representing deflection curve along all the three axes.

          @@ -2502,7 +2502,7 @@
          Documentation Version
          -max_bending_moment()[source]
          +max_bending_moment()[source]

          Returns point of max bending moment and its corresponding bending moment value along all directions in a Beam object as a list. solve_for_reaction_loads() must be called before using this function.

          @@ -2532,7 +2532,7 @@
          Documentation Version
          -max_bmoment()[source]
          +max_bmoment()[source]

          Returns point of max bending moment and its corresponding bending moment value along all directions in a Beam object as a list. solve_for_reaction_loads() must be called before using this function.

          @@ -2562,7 +2562,7 @@
          Documentation Version
          -max_deflection()[source]
          +max_deflection()[source]

          Returns point of max deflection and its corresponding deflection value along all directions in a Beam object as a list. solve_for_reaction_loads() and solve_slope_deflection() must be called @@ -2594,7 +2594,7 @@

          Documentation Version
          -max_shear_force()[source]
          +max_shear_force()[source]

          Returns point of max shear force and its corresponding shear value along all directions in a Beam object as a list. solve_for_reaction_loads() must be called before using this function.

          @@ -2630,7 +2630,7 @@
          Documentation Version
          -plot_bending_moment(dir='all', subs=None)[source]
          +plot_bending_moment(dir='all', subs=None)[source]

          Returns a plot for bending moment along all three directions present in the Beam object.

          @@ -2683,7 +2683,7 @@
          Documentation Version
          -plot_deflection(dir='all', subs=None)[source]
          +plot_deflection(dir='all', subs=None)[source]

          Returns a plot for Deflection along all three directions present in the Beam object.

          @@ -2737,7 +2737,7 @@
          Documentation Version
          -plot_loading_results(dir='x', subs=None)[source]
          +plot_loading_results(dir='x', subs=None)[source]

          Returns a subplot of Shear Force, Bending Moment, Slope and Deflection of the Beam object along the direction specified.

          @@ -2794,7 +2794,7 @@
          Documentation Version
          -plot_shear_force(dir='all', subs=None)[source]
          +plot_shear_force(dir='all', subs=None)[source]

          Returns a plot for Shear force along all three directions present in the Beam object.

          @@ -2847,7 +2847,7 @@
          Documentation Version
          -plot_shear_stress(dir='all', subs=None)[source]
          +plot_shear_stress(dir='all', subs=None)[source]

          Returns a plot for Shear Stress along all three directions present in the Beam object.

          @@ -2900,7 +2900,7 @@
          Documentation Version
          -plot_slope(dir='all', subs=None)[source]
          +plot_slope(dir='all', subs=None)[source]

          Returns a plot for Slope along all three directions present in the Beam object.

          @@ -2954,7 +2954,7 @@
          Documentation Version
          -polar_moment()[source]
          +polar_moment()[source]

          Returns the polar moment of area of the beam about the X axis with respect to the centroid.

          Examples

          @@ -2980,7 +2980,7 @@
          Documentation Version
          -shear_force()[source]
          +shear_force()[source]

          Returns a list of three expressions which represents the shear force curve of the Beam object along all three axes.

          @@ -2993,21 +2993,21 @@
          Documentation Version
          -shear_stress()[source]
          +shear_stress()[source]

          Returns a list of three expressions which represents the shear stress curve of the Beam object along all three axes.

          -slope()[source]
          +slope()[source]

          Returns a three element list representing slope of deflection curve along all the three axes.

          -solve_for_reaction_loads(*reaction)[source]
          +solve_for_reaction_loads(*reaction)[source]

          Solves for the reaction forces.

          Examples

          There is a beam of length 30 meters. It it supported by rollers at @@ -3035,7 +3035,7 @@

          Documentation Version
          -solve_for_torsion()[source]
          +solve_for_torsion()[source]

          Solves for the angular deflection due to the torsional effects of moments being applied in the x-direction i.e. out of or into the beam.

          Here, a positive torque means the direction of the torque is positive @@ -3058,7 +3058,7 @@

          Documentation Version
          -torsional_moment()[source]
          +torsional_moment()[source]

          Returns expression of Torsional moment present inside the Beam object.

          diff --git a/dev/modules/physics/continuum_mechanics/cable.html b/dev/modules/physics/continuum_mechanics/cable.html index 6a0f9fed4ae..51ec0ac4697 100644 --- a/dev/modules/physics/continuum_mechanics/cable.html +++ b/dev/modules/physics/continuum_mechanics/cable.html @@ -809,7 +809,7 @@

          Cable (Docstrings)
          -class sympy.physics.continuum_mechanics.cable.Cable(support_1, support_2)[source]
          +class sympy.physics.continuum_mechanics.cable.Cable(support_1, support_2)[source]

          Cables are structures in engineering that support the applied transverse loads through the tensile resistance developed in its members.

          @@ -834,7 +834,7 @@

          Cable (Docstrings)
          -apply_length(length)[source]
          +apply_length(length)[source]

          This method specifies the length of the cable

          Parameters:
          @@ -856,7 +856,7 @@

          Cable (Docstrings)
          -apply_load(order, load)[source]
          +apply_load(order, load)[source]

          This method adds load to the cable.

          Parameters:
          @@ -924,7 +924,7 @@

          Cable (Docstrings)
          -change_support(label, new_support)[source]
          +change_support(label, new_support)[source]

          This method changes the mentioned support with a new support.

          Parameters:
          @@ -959,7 +959,7 @@

          Cable (Docstrings)
          -draw()[source]
          +draw()[source]

          This method is used to obtain a plot for the specified cable with its supports, shape and loads.

          Examples

          @@ -1021,7 +1021,7 @@

          Cable (Docstrings)
          -plot_tension()[source]
          +plot_tension()[source]

          Returns the diagram/plot of the tension generated in the cable at various points.

          Examples

          For point loads,

          @@ -1060,7 +1060,7 @@

          Cable (Docstrings)
          -remove_loads(*args)[source]
          +remove_loads(*args)[source]

          This methods removes the specified loads.

          Parameters:
          @@ -1092,7 +1092,7 @@

          Cable (Docstrings)
          -solve(*args)[source]
          +solve(*args)[source]

          This method solves for the reaction forces at the supports, the tension developed in the cable, and updates the length of the cable.

          @@ -1156,7 +1156,7 @@

          Cable (Docstrings)
          -tension_at(x)[source]
          +tension_at(x)[source]

          Returns the tension at a given value of x developed due to distributed load.

          diff --git a/dev/modules/physics/continuum_mechanics/truss.html b/dev/modules/physics/continuum_mechanics/truss.html index c48d3947eae..c410730b163 100644 --- a/dev/modules/physics/continuum_mechanics/truss.html +++ b/dev/modules/physics/continuum_mechanics/truss.html @@ -807,7 +807,7 @@
          Documentation Version
          to 2D Trusses.

          -class sympy.physics.continuum_mechanics.truss.Truss[source]
          +class sympy.physics.continuum_mechanics.truss.Truss[source]

          A Truss is an assembly of members such as beams, connected by nodes, that create a rigid structure. In engineering, a truss is a structure that @@ -831,7 +831,7 @@

          Documentation Version

        -add_member(*args)[source]
        +add_member(*args)[source]

        This method adds a member between any two nodes in the given truss.

        Parameters:
        @@ -863,7 +863,7 @@
        Documentation Version
        -add_node(*args)[source]
        +add_node(*args)[source]

        This method adds a node to the truss along with its name/label and its location. Multiple nodes can be added at the same time.

        @@ -898,7 +898,7 @@
        Documentation Version
        -apply_load(*args)[source]
        +apply_load(*args)[source]

        This method applies external load(s) at the specified node(s).

        Parameters:
        @@ -935,7 +935,7 @@
        Documentation Version
        -apply_support(*args)[source]
        +apply_support(*args)[source]

        This method adds a pinned or roller support at specified node(s).

        Parameters:
        @@ -963,7 +963,7 @@
        Documentation Version
        -change_member_label(*args)[source]
        +change_member_label(*args)[source]

        This method changes the label(s) of the specified member(s).

        Parameters:
        @@ -1000,7 +1000,7 @@
        Documentation Version
        -change_node_label(*args)[source]
        +change_node_label(*args)[source]

        This method changes the label(s) of the specified node(s).

        Parameters:
        @@ -1031,7 +1031,7 @@
        Documentation Version
        -draw(subs_dict=None)[source]
        +draw(subs_dict=None)[source]

        Returns a plot object of the Truss with all its nodes, members, supports and loads.

        @@ -1127,7 +1127,7 @@
        Documentation Version
        -remove_load(*args)[source]
        +remove_load(*args)[source]

        This method removes already present external load(s) at specified node(s).

        @@ -1167,7 +1167,7 @@
        Documentation Version
        -remove_member(*args)[source]
        +remove_member(*args)[source]

        This method removes members from the given truss.

        Parameters:
        @@ -1193,7 +1193,7 @@
        Documentation Version
        -remove_node(*args)[source]
        +remove_node(*args)[source]

        This method removes a node from the truss. Multiple nodes can be removed at the same time.

        @@ -1220,7 +1220,7 @@
        Documentation Version
        -remove_support(*args)[source]
        +remove_support(*args)[source]

        This method removes support from specified node(s.)

        Parameters:
        @@ -1246,7 +1246,7 @@
        Documentation Version
        -solve()[source]
        +solve()[source]

        This method solves for all reaction forces of all supports and all internal forces of all the members in the truss, provided the Truss is solvable.

        A Truss is solvable if the following condition is met,

        diff --git a/dev/modules/physics/control/control_plots.html b/dev/modules/physics/control/control_plots.html index 391e575f62e..b008798aa6c 100644 --- a/dev/modules/physics/control/control_plots.html +++ b/dev/modules/physics/control/control_plots.html @@ -824,7 +824,7 @@

        Pole-Zero Plot**kwargs,

        -)[source] +)[source]

        Returns the Pole-Zero plot (also known as PZ Plot or PZ Map) of a system.

        A Pole-Zero plot is a graphical representation of a system’s poles and zeros. It is plotted on a complex plane, with circular markers representing @@ -900,7 +900,7 @@

        Pole-Zero Plot
        -control_plots.pole_zero_numerical_data()[source]
        +control_plots.pole_zero_numerical_data()[source]

        Returns the numerical data of poles and zeros of the system. It is internally used by pole_zero_plot to get the data for plotting poles and zeros. Users can use this data to further @@ -968,7 +968,7 @@

        Bode Plot**kwargs,

        -)[source] +)[source]

        Returns the Bode phase and magnitude plots of a continuous-time system.

        Parameters:
        @@ -1046,7 +1046,7 @@

        Bode Plot**kwargs,

        -)[source] +)[source]

        Returns the Bode magnitude plot of a continuous-time system.

        See bode_plot for all the parameters.

        @@ -1068,7 +1068,7 @@

        Bode Plot**kwargs,

        -)[source] +)[source]

        Returns the Bode phase plot of a continuous-time system.

        See bode_plot for all the parameters.

        @@ -1084,7 +1084,7 @@

        Bode Plot**kwargs,

        -)[source] +)[source]

        Returns the numerical data of the Bode magnitude plot of the system. It is internally used by bode_magnitude_plot to get the data for plotting Bode magnitude plot. Users can use this data to further @@ -1160,7 +1160,7 @@

        Bode Plot**kwargs,

        -)[source] +)[source]

        Returns the numerical data of the Bode phase plot of the system. It is internally used by bode_phase_plot to get the data for plotting Bode phase plot. Users can use this data to further @@ -1249,7 +1249,7 @@

        Impulse-Response Plot**kwargs,

        -)[source] +)[source]

        Returns the unit impulse response (Input is the Dirac-Delta Function) of a continuous-time system.

        @@ -1327,7 +1327,7 @@

        Impulse-Response Plot**kwargs,

        -)[source] +)[source]

        Returns the numerical values of the points in the impulse response plot of a SISO continuous-time system. By default, adaptive sampling is used. If the user wants to instead get an uniformly @@ -1416,7 +1416,7 @@

        Step-Response Plot**kwargs,

        -)[source] +)[source]

        Returns the unit step response of a continuous-time system. It is the response of the system when the input signal is a step function.

        @@ -1494,7 +1494,7 @@

        Step-Response Plot**kwargs,

        -)[source] +)[source]

        Returns the numerical values of the points in the step response plot of a SISO continuous-time system. By default, adaptive sampling is used. If the user wants to instead get an uniformly @@ -1584,7 +1584,7 @@

        Ramp-Response Plot**kwargs,

        -)[source] +)[source]

        Returns the ramp response of a continuous-time system.

        Ramp function is defined as the straight line passing through origin (\(f(x) = mx\)). The slope of @@ -1670,7 +1670,7 @@

        Ramp-Response Plot**kwargs,

        -)[source] +)[source]

        Returns the numerical values of the points in the ramp response plot of a SISO continuous-time system. By default, adaptive sampling is used. If the user wants to instead get an uniformly @@ -1761,7 +1761,7 @@

        Nyquist Plot**kwargs,

        -)[source] +)[source]

        Generates the Nyquist plot for a continuous-time system.

        Parameters:
        @@ -1828,7 +1828,7 @@

        Nichols Plot**kwargs,

        -)[source] +)[source]

        Generates the Nichols plot for a LTI system.

        Parameters:
        diff --git a/dev/modules/physics/control/lti.html b/dev/modules/physics/control/lti.html index 6dbc5826eea..3a2f9e6741e 100644 --- a/dev/modules/physics/control/lti.html +++ b/dev/modules/physics/control/lti.html @@ -807,7 +807,7 @@

        Control API

        lti

        -class sympy.physics.control.lti.TransferFunction(num, den, var)[source]
        +class sympy.physics.control.lti.TransferFunction(num, den, var)[source]

        A class for representing LTI (Linear, time-invariant) systems that can be strictly described by ratio of polynomials in the Laplace transform complex variable. The arguments are num, den, and var, where num and den are numerator and @@ -998,7 +998,7 @@

        Control API
        -dc_gain()[source]
        +dc_gain()[source]

        Computes the gain of the response as the frequency approaches zero.

        The DC gain is infinite for systems with pure integrators.

        Examples

        @@ -1039,7 +1039,7 @@

        Control API
        -eval_frequency(other)[source]
        +eval_frequency(other)[source]

        Returns the system response at any point in the real or complex plane.

        Examples

        >>> from sympy.abc import s, p, a
        @@ -1060,7 +1060,7 @@ 

        Control API
        -expand()[source]
        +expand()[source]

        Returns the transfer function with numerator and denominator in expanded form.

        Examples

        @@ -1086,7 +1086,7 @@

        Control APIvar,

        -)[source] +)[source]

        Creates a new TransferFunction efficiently from a list of coefficients.

        Parameters:
        @@ -1136,7 +1136,7 @@

        Control APIvar=None,

        -)[source] +)[source]

        Creates a new TransferFunction efficiently from a rational expression.

        Parameters:
        @@ -1202,7 +1202,7 @@

        Control API
        -classmethod from_zpk(zeros, poles, gain, var)[source]
        +classmethod from_zpk(zeros, poles, gain, var)[source]

        Creates a new TransferFunction from given zeros, poles and gain.

        Parameters:
        @@ -1284,7 +1284,7 @@

        Control API
        -is_stable()[source]
        +is_stable()[source]

        Returns True if the transfer function is asymptotically stable; else False.

        This would not check the marginal or conditional stability of the system.

        Examples

        @@ -1345,7 +1345,7 @@

        Control API
        -poles()[source]
        +poles()[source]

        Returns the poles of a transfer function.

        Examples

        >>> from sympy.abc import s, p, a
        @@ -1365,7 +1365,7 @@ 

        Control API
        -to_expr()[source]
        +to_expr()[source]

        Converts a TransferFunction object to SymPy Expr.

        Examples

        >>> from sympy.abc import s, p, a, b
        @@ -1406,7 +1406,7 @@ 

        Control API
        -zeros()[source]
        +zeros()[source]

        Returns the zeros of a transfer function.

        Examples

        >>> from sympy.abc import s, p, a
        @@ -1428,7 +1428,7 @@ 

        Control API
        -class sympy.physics.control.lti.Series(*args, evaluate=False)[source]
        +class sympy.physics.control.lti.Series(*args, evaluate=False)[source]

        A class for representing a series configuration of SISO systems.

        Parameters:
        @@ -1521,7 +1521,7 @@

        Control API
        -doit(**hints)[source]
        +doit(**hints)[source]

        Returns the resultant transfer function or StateSpace obtained after evaluating the series interconnection.

        Examples

        @@ -1609,7 +1609,7 @@

        Control API
        -to_expr()[source]
        +to_expr()[source]

        Returns the equivalent Expr object.

        @@ -1635,7 +1635,7 @@

        Control API
        -class sympy.physics.control.lti.Parallel(*args, evaluate=False)[source]
        +class sympy.physics.control.lti.Parallel(*args, evaluate=False)[source]

        A class for representing a parallel configuration of SISO systems.

        Parameters:
        @@ -1731,7 +1731,7 @@

        Control API
        -doit(**hints)[source]
        +doit(**hints)[source]

        Returns the resultant transfer function or state space obtained by parallel connection of transfer functions or state space objects.

        Examples

        @@ -1815,7 +1815,7 @@

        Control API
        -to_expr()[source]
        +to_expr()[source]

        Returns the equivalent Expr object.

        @@ -1841,7 +1841,7 @@

        Control API
        -class sympy.physics.control.lti.Feedback(sys1, sys2=None, sign=-1)[source]
        +class sympy.physics.control.lti.Feedback(sys1, sys2=None, sign=-1)[source]

        A class for representing closed-loop feedback interconnection between two SISO input/output systems.

        The first argument, sys1, is the feedforward part of the closed-loop @@ -1966,7 +1966,7 @@

        Control API
        -doit(cancel=False, expand=False, **hints)[source]
        +doit(cancel=False, expand=False, **hints)[source]

        Returns the resultant transfer function or state space obtained by feedback connection of transfer functions or state space objects.

        Examples

        @@ -2101,7 +2101,7 @@

        Control API
        -to_expr()[source]
        +to_expr()[source]

        Converts a Feedback object to SymPy Expr.

        Examples

        >>> from sympy.abc import s, a, b
        @@ -2145,7 +2145,7 @@ 

        Control API
        -class sympy.physics.control.lti.TransferFunctionMatrix(arg)[source]
        +class sympy.physics.control.lti.TransferFunctionMatrix(arg)[source]

        A class for representing the MIMO (multiple-input and multiple-output) generalization of the SISO (single-input and single-output) transfer function.

        It is a matrix of transfer functions (TransferFunction, SISO-Series or SISO-Parallel). @@ -2499,7 +2499,7 @@

        Control API
        -elem_poles()[source]
        +elem_poles()[source]

        Returns the poles of each element of the TransferFunctionMatrix.

        Note

        @@ -2527,7 +2527,7 @@

        Control API
        -elem_zeros()[source]
        +elem_zeros()[source]

        Returns the zeros of each element of the TransferFunctionMatrix.

        Note

        @@ -2555,7 +2555,7 @@

        Control API
        -eval_frequency(other)[source]
        +eval_frequency(other)[source]

        Evaluates system response of each transfer function in the TransferFunctionMatrix at any point in the real or complex plane.

        Examples

        >>> from sympy.abc import s
        @@ -2582,13 +2582,13 @@ 

        Control API
        -expand(**hints)[source]
        +expand(**hints)[source]

        Expands the transfer function matrix

        -classmethod from_Matrix(matrix, var)[source]
        +classmethod from_Matrix(matrix, var)[source]

        Creates a new TransferFunctionMatrix efficiently from a SymPy Matrix of Expr objects.

        Parameters:
        @@ -2687,7 +2687,7 @@

        Control API
        -transpose()[source]
        +transpose()[source]

        Returns the transpose of the TransferFunctionMatrix (switched input and output layers).

        @@ -2722,7 +2722,7 @@

        Control API
        -class sympy.physics.control.lti.PIDController(kp=kp, ki=ki, kd=kd, tf=0, var=s)[source]
        +class sympy.physics.control.lti.PIDController(kp=kp, ki=ki, kd=kd, tf=0, var=s)[source]

        A class for representing PID (Proportional-Integral-Derivative) controllers in control systems. The PIDController class is a subclass of TransferFunction, representing the controller’s transfer function @@ -2796,7 +2796,7 @@

        Control API
        -doit()[source]
        +doit()[source]

        Convert the PIDController into TransferFunction.

        @@ -2828,7 +2828,7 @@

        Control API
        -class sympy.physics.control.lti.MIMOSeries(*args, evaluate=False)[source]
        +class sympy.physics.control.lti.MIMOSeries(*args, evaluate=False)[source]

        A class for representing a series configuration of MIMO systems.

        Parameters:
        @@ -2952,7 +2952,7 @@

        Control API
        -doit(cancel=False, **kwargs)[source]
        +doit(cancel=False, **kwargs)[source]

        Returns the resultant obtained after evaluating the MIMO systems arranged in a series configuration. For TransferFunction systems it returns a TransferFunctionMatrix and for StateSpace systems it returns the resultant StateSpace system.

        @@ -3009,7 +3009,7 @@

        Control API
        -class sympy.physics.control.lti.MIMOParallel(*args, evaluate=False)[source]
        +class sympy.physics.control.lti.MIMOParallel(*args, evaluate=False)[source]

        A class for representing a parallel configuration of MIMO systems.

        Parameters:
        @@ -3140,7 +3140,7 @@

        Control API
        -doit(**hints)[source]
        +doit(**hints)[source]

        Returns the resultant transfer function matrix or StateSpace obtained after evaluating the MIMO systems arranged in a parallel configuration.

        Examples

        @@ -3197,7 +3197,7 @@

        Control API
        -class sympy.physics.control.lti.MIMOFeedback(sys1, sys2, sign=-1)[source]
        +class sympy.physics.control.lti.MIMOFeedback(sys1, sys2, sign=-1)[source]

        A class for representing closed-loop feedback interconnection between two MIMO input/output systems.

        @@ -3344,7 +3344,7 @@

        Control API**hints,

        -)[source] +)[source]

        Returns the resultant transfer function matrix obtained by the feedback interconnection.

        Examples

        @@ -3562,7 +3562,7 @@

        Control API
        -class sympy.physics.control.lti.StateSpace(A=None, B=None, C=None, D=None)[source]
        +class sympy.physics.control.lti.StateSpace(A=None, B=None, C=None, D=None)[source]

        State space model (ssm) of a linear, time invariant control system.

        Represents the standard state-space model with A, B, C, D as state-space matrices. This makes the linear control system:

        @@ -3713,7 +3713,7 @@

        Control API
        -append(other)[source]
        +append(other)[source]

        Returns the first model appended with the second model. The order is preserved.

        Examples

        >>> from sympy import Matrix
        @@ -3744,7 +3744,7 @@ 

        Control API
        -controllability_matrix()[source]
        +controllability_matrix()[source]
        Returns the controllability matrix of the system:

        [B, A * B, A^2 * B, .. , A^(n-1) * B]; A in R^(n x n), B in R^(n x m)

        @@ -3774,7 +3774,7 @@

        Control API
        -controllable_subspace()[source]
        +controllable_subspace()[source]

        Returns the controllable subspace of the state space model.

        Examples

        >>> from sympy import Matrix
        @@ -3805,7 +3805,7 @@ 

        Control APIvar=t,

        -)[source] +)[source]
        Returns \(y(t)\) or output of StateSpace given by the solution of equations:

        x’(t) = A * x(t) + B * u(t) y(t) = C * x(t) + D * u(t)

        @@ -3898,7 +3898,7 @@

        Control API
        -is_controllable()[source]
        +is_controllable()[source]

        Returns if the state space model is controllable.

        Examples

        >>> from sympy import Matrix
        @@ -3916,7 +3916,7 @@ 

        Control API
        -is_observable()[source]
        +is_observable()[source]

        Returns if the state space model is observable.

        Examples

        >>> from sympy import Matrix
        @@ -3988,7 +3988,7 @@ 

        Control API
        -observability_matrix()[source]
        +observability_matrix()[source]
        Returns the observability matrix of the state space model:

        [C, C * A^1, C * A^2, .. , C * A^(n-1)]; A in R^(n x n), C in R^(m x k)

        @@ -4019,7 +4019,7 @@

        Control API
        -observable_subspace()[source]
        +observable_subspace()[source]

        Returns the observable subspace of the state space model.

        Examples

        >>> from sympy import Matrix
        @@ -4088,7 +4088,7 @@ 

        Control API
        -sympy.physics.control.lti.gbt(tf, sample_per, alpha)[source]
        +sympy.physics.control.lti.gbt(tf, sample_per, alpha)[source]

        Returns falling coefficients of H(z) from numerator and denominator.

        Explanation

        Where H(z) is the corresponding discretized transfer function, @@ -4143,7 +4143,7 @@

        Control API
        -sympy.physics.control.lti.bilinear(tf, sample_per)[source]
        +sympy.physics.control.lti.bilinear(tf, sample_per)[source]

        Returns falling coefficients of H(z) from numerator and denominator.

        Explanation

        Where H(z) is the corresponding discretized transfer function, @@ -4170,7 +4170,7 @@

        Control API
        -sympy.physics.control.lti.forward_diff(tf, sample_per)[source]
        +sympy.physics.control.lti.forward_diff(tf, sample_per)[source]

        Returns falling coefficients of H(z) from numerator and denominator.

        Explanation

        Where H(z) is the corresponding discretized transfer function, @@ -4197,7 +4197,7 @@

        Control API
        -sympy.physics.control.lti.backward_diff(tf, sample_per)[source]
        +sympy.physics.control.lti.backward_diff(tf, sample_per)[source]

        Returns falling coefficients of H(z) from numerator and denominator.

        Explanation

        Where H(z) is the corresponding discretized transfer function, diff --git a/dev/modules/physics/hep/index.html b/dev/modules/physics/hep/index.html index f96110e14f4..48955b6143b 100644 --- a/dev/modules/physics/hep/index.html +++ b/dev/modules/physics/hep/index.html @@ -836,7 +836,7 @@

        Examples
        -sympy.physics.hep.gamma_matrices.extract_type_tens(expression, component)[source]
        +sympy.physics.hep.gamma_matrices.extract_type_tens(expression, component)[source]

        Extract from a TensExpr all tensors with \(component\).

        Returns two tensor expressions:

          @@ -847,7 +847,7 @@

          Examples
          -sympy.physics.hep.gamma_matrices.gamma_trace(t)[source]
          +sympy.physics.hep.gamma_matrices.gamma_trace(t)[source]

          trace of a single line of gamma matrices

          Examples

          >>> from sympy.physics.hep.gamma_matrices import GammaMatrix as G,         gamma_trace, LorentzIndex
          @@ -868,7 +868,7 @@ 

          Examples
          -sympy.physics.hep.gamma_matrices.kahane_simplify(expression)[source]
          +sympy.physics.hep.gamma_matrices.kahane_simplify(expression)[source]

          This function cancels contracted elements in a product of four dimensional gamma matrices, resulting in an expression equal to the given one, without the contracted gamma matrices.

          @@ -935,7 +935,7 @@

          Examples
          -sympy.physics.hep.gamma_matrices.simplify_gpgp(ex, sort=True)[source]
          +sympy.physics.hep.gamma_matrices.simplify_gpgp(ex, sort=True)[source]

          simplify products G(i)*p(-i)*G(j)*p(-j) -> p(i)*p(-i)

          Examples

          >>> from sympy.physics.hep.gamma_matrices import GammaMatrix as G,         LorentzIndex, simplify_gpgp
          diff --git a/dev/modules/physics/hydrogen.html b/dev/modules/physics/hydrogen.html
          index b46516e89a4..af9ef36510e 100644
          --- a/dev/modules/physics/hydrogen.html
          +++ b/dev/modules/physics/hydrogen.html
          @@ -805,7 +805,7 @@ 
          Documentation Version

          Hydrogen Wavefunctions

          -sympy.physics.hydrogen.E_nl(n, Z=1)[source]
          +sympy.physics.hydrogen.E_nl(n, Z=1)[source]

          Returns the energy of the state (n, l) in Hartree atomic units.

          The energy does not depend on “l”.

          @@ -850,7 +850,7 @@
          Documentation Version
          c=137.035999037000,
          -)[source] +)[source]

          Returns the relativistic energy of the state (n, l, spin) in Hartree atomic units.

          The energy is calculated from the Dirac equation. The rest mass energy is @@ -912,7 +912,7 @@

          Documentation Version
          -sympy.physics.hydrogen.Psi_nlm(n, l, m, r, phi, theta, Z=1)[source]
          +sympy.physics.hydrogen.Psi_nlm(n, l, m, r, phi, theta, Z=1)[source]

          Returns the Hydrogen wave function psi_{nlm}. It’s the product of the radial wavefunction R_{nl} and the spherical harmonic Y_{l}^{m}.

          @@ -979,7 +979,7 @@
          Documentation Version
          -sympy.physics.hydrogen.R_nl(n, l, r, Z=1)[source]
          +sympy.physics.hydrogen.R_nl(n, l, r, Z=1)[source]

          Returns the Hydrogen radial wavefunction R_{nl}.

          Parameters:
          diff --git a/dev/modules/physics/matrices.html b/dev/modules/physics/matrices.html index 004f48b5de1..b8b165180df 100644 --- a/dev/modules/physics/matrices.html +++ b/dev/modules/physics/matrices.html @@ -806,7 +806,7 @@
          Documentation Version

          Known matrices related to physics

          -sympy.physics.matrices.mdft(n)[source]
          +sympy.physics.matrices.mdft(n)[source]

          Deprecated since version 1.9: Use DFT from sympy.matrices.expressions.fourier instead.

          To get identical behavior to mdft(n), use DFT(n).as_explicit().

          @@ -815,7 +815,7 @@
          Documentation Version
          -sympy.physics.matrices.mgamma(mu, lower=False)[source]
          +sympy.physics.matrices.mgamma(mu, lower=False)[source]

          Returns a Dirac gamma matrix \(\gamma^\mu\) in the standard (Dirac) representation.

          Explanation

          @@ -844,7 +844,7 @@
          Documentation Version
          -sympy.physics.matrices.msigma(i)[source]
          +sympy.physics.matrices.msigma(i)[source]

          Returns a Pauli matrix \(\sigma_i\) with \(i=1,2,3\).

          Examples

          >>> from sympy.physics.matrices import msigma
          @@ -865,7 +865,7 @@ 
          Documentation Version
          -sympy.physics.matrices.pat_matrix(m, dx, dy, dz)[source]
          +sympy.physics.matrices.pat_matrix(m, dx, dy, dz)[source]

          Returns the Parallel Axis Theorem matrix to translate the inertia matrix a distance of \((dx, dy, dz)\) for a body of mass m.

          Examples

          diff --git a/dev/modules/physics/mechanics/api/actuator.html b/dev/modules/physics/mechanics/api/actuator.html index dd6292122e0..82b23e4240b 100644 --- a/dev/modules/physics/mechanics/api/actuator.html +++ b/dev/modules/physics/mechanics/api/actuator.html @@ -806,14 +806,14 @@
          Documentation Version

          Implementations of actuators for linked force and torque application.

          -class sympy.physics.mechanics.actuator.ActuatorBase[source]
          +class sympy.physics.mechanics.actuator.ActuatorBase[source]

          Abstract base class for all actuator classes to inherit from.

          Notes

          Instances of this class cannot be directly instantiated by users. However, it can be used to created custom actuator types through subclassing.

          -abstract to_loads()[source]
          +abstract to_loads()[source]

          Loads required by the equations of motion method classes.

          Explanation

          KanesMethod requires a list of Point-Vector tuples to be @@ -842,7 +842,7 @@

          Documentation Version
          mu_s=None,
          -)[source] +)[source]

          Coulomb kinetic friction with Stribeck and viscous effects.

          Parameters:
          @@ -1001,7 +1001,7 @@
          Documentation Version
          equilibrium_length=0,
          -)[source] +)[source]

          A nonlinear spring based on the Duffing equation.

          Parameters:
          @@ -1037,7 +1037,7 @@
          Documentation Version
          -class sympy.physics.mechanics.actuator.ForceActuator(force, pathway)[source]
          +class sympy.physics.mechanics.actuator.ForceActuator(force, pathway)[source]

          Force-producing actuator.

          Parameters:
          @@ -1115,7 +1115,7 @@
          Documentation Version
          -to_loads()[source]
          +to_loads()[source]

          Loads required by the equations of motion method classes.

          Explanation

          KanesMethod requires a list of Point-Vector tuples to be @@ -1186,7 +1186,7 @@

          Documentation Version
          -class sympy.physics.mechanics.actuator.LinearDamper(damping, pathway)[source]
          +class sympy.physics.mechanics.actuator.LinearDamper(damping, pathway)[source]

          A damper whose force is a linear function of its extension velocity.

          Parameters:
          @@ -1304,7 +1304,7 @@
          Documentation Version
          equilibrium_length=0,
          -)[source] +)[source]

          A spring with its spring force as a linear function of its length.

          Parameters:
          @@ -1441,7 +1441,7 @@
          Documentation Version
          reaction_frame=None,
          -)[source] +)[source]

          Torque-producing actuator.

          Parameters:
          @@ -1492,7 +1492,7 @@
          Documentation Version
          when one is passed instead of a ReferenceFrame.

          -classmethod at_pin_joint(torque, pin_joint)[source]
          +classmethod at_pin_joint(torque, pin_joint)[source]

          Alternate construtor to instantiate from a PinJoint instance.

          Parameters:
          @@ -1571,7 +1571,7 @@
          Documentation Version
          -to_loads()[source]
          +to_loads()[source]

          Loads required by the equations of motion method classes.

          Explanation

          KanesMethod requires a list of Point-Vector tuples to be diff --git a/dev/modules/physics/mechanics/api/deprecated_classes.html b/dev/modules/physics/mechanics/api/deprecated_classes.html index c6a3f7046e2..66b57f8f3b7 100644 --- a/dev/modules/physics/mechanics/api/deprecated_classes.html +++ b/dev/modules/physics/mechanics/api/deprecated_classes.html @@ -821,7 +821,7 @@

          Deprecated Classes (Docstrings)central_inertia=None,

          -)[source] +)[source]

          Body is a common representation of either a RigidBody or a Particle SymPy object depending on what is passed in during initialization. If a mass is passed in and central_inertia is left as None, the Particle object is @@ -932,7 +932,7 @@

          Deprecated Classes (Docstrings)
          -ang_vel_in(body)[source]
          +ang_vel_in(body)[source]

          Returns this body’s angular velocity with respect to the provided rigid body or reference frame.

          @@ -966,7 +966,7 @@

          Deprecated Classes (Docstrings)
          -angular_momentum(point, frame)[source]
          +angular_momentum(point, frame)[source]

          Returns the angular momentum of the rigid body about a point in the given frame.

          @@ -1019,7 +1019,7 @@

          Deprecated Classes (Docstrings)reaction_point=None,

          -)[source] +)[source]

          Add force to the body(s).

          Parameters:
          @@ -1113,7 +1113,7 @@

          Deprecated Classes (Docstrings)
          -apply_torque(torque, reaction_body=None)[source]
          +apply_torque(torque, reaction_body=None)[source]

          Add torque to the body(s).

          Parameters:
          @@ -1199,7 +1199,7 @@

          Deprecated Classes (Docstrings)
          -clear_loads()[source]
          +clear_loads()[source]

          Clears the Body’s loads list.

          Example

          As Body has been deprecated, the following examples are for illustrative @@ -1223,7 +1223,7 @@

          Deprecated Classes (Docstrings)
          -dcm(body)[source]
          +dcm(body)[source]

          Returns the direction cosine matrix of this body relative to the provided rigid body or reference frame.

          @@ -1273,7 +1273,7 @@

          Deprecated Classes (Docstrings)
          -kinetic_energy(frame)[source]
          +kinetic_energy(frame)[source]

          Kinetic energy of the body.

          Parameters:
          @@ -1325,7 +1325,7 @@

          Deprecated Classes (Docstrings)
          -linear_momentum(frame)[source]
          +linear_momentum(frame)[source]

          Linear momentum of the rigid body.

          Parameters:
          @@ -1373,7 +1373,7 @@

          Deprecated Classes (Docstrings)
          -masscenter_vel(body)[source]
          +masscenter_vel(body)[source]

          Returns the velocity of the mass center with respect to the provided rigid body or reference frame.

          @@ -1411,7 +1411,7 @@

          Deprecated Classes (Docstrings)
          -parallel_axis(point, frame=None)[source]
          +parallel_axis(point, frame=None)[source]

          Returns the inertia dyadic of the body with respect to another point.

          @@ -1477,7 +1477,7 @@

          Deprecated Classes (Docstrings)
          -remove_load(about=None)[source]
          +remove_load(about=None)[source]

          Remove load about a point or frame.

          Parameters:
          @@ -1537,7 +1537,7 @@

          Deprecated Classes (Docstrings)
          -class sympy.physics.mechanics.jointsmethod.JointsMethod(newtonion, *joints)[source]
          +class sympy.physics.mechanics.jointsmethod.JointsMethod(newtonion, *joints)[source]

          Method for formulating the equations of motion using a set of interconnected bodies with joints.

          Deprecated since version 1.13: The JointsMethod class is deprecated. Its functionality has been @@ -1653,7 +1653,7 @@

          Deprecated Classes (Docstrings)method=<class 'sympy.physics.mechanics.kane.KanesMethod'>,

          -)[source] +)[source]

          Method to form system’s equation of motions.

          Parameters:
          @@ -1746,7 +1746,7 @@

          Deprecated Classes (Docstrings)
          -rhs(inv_method=None)[source]
          +rhs(inv_method=None)[source]

          Returns equations that can be solved numerically.

          Parameters:
          diff --git a/dev/modules/physics/mechanics/api/expr_manip.html b/dev/modules/physics/mechanics/api/expr_manip.html index bdf078ae4ea..b56a5cc99ab 100644 --- a/dev/modules/physics/mechanics/api/expr_manip.html +++ b/dev/modules/physics/mechanics/api/expr_manip.html @@ -805,7 +805,7 @@
          Documentation Version

          Expression Manipulation (Docstrings)

          -sympy.physics.mechanics.msubs(expr, *sub_dicts, smart=False, **kwargs)[source]
          +sympy.physics.mechanics.msubs(expr, *sub_dicts, smart=False, **kwargs)[source]

          A custom subs for use on expressions derived in physics.mechanics.

          Traverses the expression tree once, performing the subs found in sub_dicts. Terms inside Derivative expressions are ignored:

          @@ -851,7 +851,7 @@

          Expression Manipulation (Docstrings)reference_frame=None,

          -)[source] +)[source]

          Find all dynamicsymbols in expression.

          Parameters:
          diff --git a/dev/modules/physics/mechanics/api/joint.html b/dev/modules/physics/mechanics/api/joint.html index de642a76223..be3591546fd 100644 --- a/dev/modules/physics/mechanics/api/joint.html +++ b/dev/modules/physics/mechanics/api/joint.html @@ -825,7 +825,7 @@

          Joints Framework (Docstrings)child_joint_pos=None,

          -)[source] +)[source]

          Abstract base class for all specific joints.

          Parameters:
          @@ -1059,7 +1059,7 @@

          Joints Framework (Docstrings)child_joint_pos=None,

          -)[source] +)[source]

          Pin (Revolute) Joint.

          @@ -1390,7 +1390,7 @@

          Joints Framework (Docstrings)child_joint_pos=None,

          -)[source] +)[source]

          Prismatic (Sliding) Joint.

          ../../../../_images/PrismaticJoint.svg
          @@ -1677,7 +1677,7 @@

          Joints Framework (Docstrings)joint_axis=None,

          -)[source] +)[source]

          Cylindrical Joint.

          ../../../../_images/CylindricalJoint.svg @@ -1983,7 +1983,7 @@

          Joints Framework (Docstrings)child_interframe=None,

          -)[source] +)[source]

          Planar Joint.

          Joints Framework (Docstrings)rot_order=123,

          -)[source] +)[source]

          Spherical (Ball-and-Socket) Joint.

          ../../../../_images/SphericalJoint.svg @@ -2750,7 +2750,7 @@

          Joints Framework (Docstrings)child_interframe=None,

          -)[source] +)[source]

          Weld Joint.

          diff --git a/dev/modules/physics/mechanics/api/kane_lagrange.html b/dev/modules/physics/mechanics/api/kane_lagrange.html index 89078fc1a4f..9205e3a81b1 100644 --- a/dev/modules/physics/mechanics/api/kane_lagrange.html +++ b/dev/modules/physics/mechanics/api/kane_lagrange.html @@ -825,7 +825,7 @@
          Documentation Version
          constraint_solver='LU',

          -)[source] +)[source]

          Kane’s method object.

          Parameters:
          @@ -1070,7 +1070,7 @@
          Documentation Version
          loads=None,
          -)[source] +)[source]

          Method to form Kane’s equations, Fr + Fr* = 0.

          Parameters:
          @@ -1099,7 +1099,7 @@
          Documentation Version
          -kindiffdict()[source]
          +kindiffdict()[source]

          Returns a dictionary mapping q’ to u.

          @@ -1114,7 +1114,7 @@
          Documentation Version
          **kwargs,
          -)[source] +)[source]

          Linearize the equations of motion about a symbolic operating point.

          Parameters:
          @@ -1182,7 +1182,7 @@
          Documentation Version
          -rhs(inv_method=None)[source]
          +rhs(inv_method=None)[source]

          Returns the system’s equations of motion in first order form. The output is the right hand side of:

          x' = |q'| =: f(q, u, r, p, t)
          @@ -1205,7 +1205,7 @@ 
          Documentation Version
          -to_linearizer(linear_solver='LU')[source]
          +to_linearizer(linear_solver='LU')[source]

          Returns an instance of the Linearizer class, initiated from the data in the KanesMethod class. This may be more desirable than using the linearize class method, as the Linearizer object will allow more @@ -1251,7 +1251,7 @@

          Documentation Version
          nonhol_coneqs=None,
          -)[source] +)[source]

          Lagrange’s method object.

          Explanation

          This object generates the equations of motion in a two step procedure. The @@ -1355,7 +1355,7 @@

          Documentation Version
          -form_lagranges_equations()[source]
          +form_lagranges_equations()[source]

          Method to form Lagrange’s equations of motion.

          Returns a vector of equations of motion using Lagrange’s equations of the second kind.

          @@ -1374,7 +1374,7 @@
          Documentation Version
          **kwargs,
          -)[source] +)[source]

          Linearize the equations of motion about a symbolic operating point.

          Parameters:
          @@ -1439,7 +1439,7 @@
          Documentation Version
          -rhs(inv_method=None, **kwargs)[source]
          +rhs(inv_method=None, **kwargs)[source]

          Returns equations that can be solved numerically.

          Parameters:
          @@ -1462,7 +1462,7 @@
          Documentation Version
          sol_type='dict',
          -)[source] +)[source]

          Solves for the values of the lagrange multipliers symbolically at the specified operating point.

          @@ -1495,7 +1495,7 @@
          Documentation Version
          linear_solver='LU',
          -)[source] +)[source]

          Returns an instance of the Linearizer class, initiated from the data in the LagrangesMethod class. This may be more desirable than using the linearize class method, as the Linearizer object will allow more diff --git a/dev/modules/physics/mechanics/api/linearize.html b/dev/modules/physics/mechanics/api/linearize.html index 01a7dd51a69..54588eff580 100644 --- a/dev/modules/physics/mechanics/api/linearize.html +++ b/dev/modules/physics/mechanics/api/linearize.html @@ -827,7 +827,7 @@

          Documentation Version
          linear_solver='LU',
          -)[source] +)[source]

          This object holds the general model form for a dynamic system. This model is used for computing the linearized form of the system, while properly dealing with constraints leading to dependent coordinates and @@ -889,7 +889,7 @@

          Documentation Version
          linear_solver='LU',
          -)[source] +)[source]
          Parameters:

          f_0, f_1, f_2, f_3, f_4, f_c, f_v, f_a : array_like

          @@ -948,7 +948,7 @@
          Documentation Version
          simplify=False,
          -)[source] +)[source]

          Linearize the system about the operating point. Note that q_op, u_op, qd_op, ud_op must satisfy the equations of motion. These may be either symbolic or numeric.

          diff --git a/dev/modules/physics/mechanics/api/part_bod.html b/dev/modules/physics/mechanics/api/part_bod.html index 79fd554a0c3..9be360129ea 100644 --- a/dev/modules/physics/mechanics/api/part_bod.html +++ b/dev/modules/physics/mechanics/api/part_bod.html @@ -807,7 +807,7 @@
          Documentation Version

          Bodies

          -class sympy.physics.mechanics.particle.Particle(name, point=None, mass=None)[source]
          +class sympy.physics.mechanics.particle.Particle(name, point=None, mass=None)[source]

          A particle.

          Parameters:
          @@ -847,7 +847,7 @@

          Bodies
          -angular_momentum(point, frame)[source]
          +angular_momentum(point, frame)[source]

          Angular momentum of the particle about the point.

          Parameters:
          @@ -887,7 +887,7 @@

          Bodies
          -kinetic_energy(frame)[source]
          +kinetic_energy(frame)[source]

          Kinetic energy of the particle.

          Parameters:
          @@ -920,7 +920,7 @@

          Bodies
          -linear_momentum(frame)[source]
          +linear_momentum(frame)[source]

          Linear momentum of the particle.

          Parameters:
          @@ -972,7 +972,7 @@

          Bodies
          -parallel_axis(point, frame)[source]
          +parallel_axis(point, frame)[source]

          Returns an inertia dyadic of the particle with respect to another point and frame.

          @@ -1033,7 +1033,7 @@

          Bodiesinertia=None,

          -)[source] +)[source]

          An idealized rigid body.

          Explanation

          This is essentially a container which holds the various components which @@ -1083,7 +1083,7 @@

          Bodies
          -angular_momentum(point, frame)[source]
          +angular_momentum(point, frame)[source]

          Returns the angular momentum of the rigid body about a point in the given frame.

          @@ -1145,7 +1145,7 @@

          Bodies
          -kinetic_energy(frame)[source]
          +kinetic_energy(frame)[source]

          Kinetic energy of the rigid body.

          Parameters:
          @@ -1185,7 +1185,7 @@

          Bodies
          -linear_momentum(frame)[source]
          +linear_momentum(frame)[source]

          Linear momentum of the rigid body.

          Parameters:
          @@ -1239,7 +1239,7 @@

          Bodies
          -parallel_axis(point, frame=None)[source]
          +parallel_axis(point, frame=None)[source]

          Returns the inertia dyadic of the body with respect to another point.

          Parameters:
          @@ -1304,7 +1304,7 @@

          BodiesInertias

          -class sympy.physics.mechanics.inertia.Inertia(dyadic, point)[source]
          +class sympy.physics.mechanics.inertia.Inertia(dyadic, point)[source]

          Inertia object consisting of a Dyadic and a Point of reference.

          Explanation

          This is a simple class to store the Point and Dyadic, belonging to an @@ -1352,7 +1352,7 @@

          Inertias
          izx=0,

          -)[source] +)[source]

          Simple way to create an Inertia object based on the tensor values.

          Parameters:
          @@ -1417,7 +1417,7 @@

          Inertias
          -sympy.physics.mechanics.inertia.inertia(frame, ixx, iyy, izz, ixy=0, iyz=0, izx=0)[source]
          +sympy.physics.mechanics.inertia.inertia(frame, ixx, iyy, izz, ixy=0, iyz=0, izx=0)[source]

          Simple way to create inertia Dyadic object.

          Parameters:
          @@ -1465,7 +1465,7 @@

          Inertias
          -sympy.physics.mechanics.inertia.inertia_of_point_mass(mass, pos_vec, frame)[source]
          +sympy.physics.mechanics.inertia.inertia_of_point_mass(mass, pos_vec, frame)[source]

          Inertia dyadic of a point mass relative to point O.

          Parameters:
          @@ -1500,7 +1500,7 @@

          Inertias

          Loads

          -class sympy.physics.mechanics.loads.Force(point, force)[source]
          +class sympy.physics.mechanics.loads.Force(point, force)[source]

          Force acting upon a point.

          Explanation

          A force is a vector that is bound to a line of action. This class stores @@ -1528,7 +1528,7 @@

          Loads
          -class sympy.physics.mechanics.loads.Torque(frame, torque)[source]
          +class sympy.physics.mechanics.loads.Torque(frame, torque)[source]

          Torque acting upon a frame.

          Explanation

          A torque is a free vector that is acting on a reference frame, which is @@ -1558,7 +1558,7 @@

          Loads

          Other Functions

          -sympy.physics.mechanics.functions.center_of_mass(point, *bodies)[source]
          +sympy.physics.mechanics.functions.center_of_mass(point, *bodies)[source]

          Returns the position vector from the given point to the center of mass of the given bodies(particles or rigidbodies).

          Example

          @@ -1591,7 +1591,7 @@

          Other Functions
          -sympy.physics.mechanics.functions.linear_momentum(frame, *body)[source]
          +sympy.physics.mechanics.functions.linear_momentum(frame, *body)[source]

          Linear momentum of the system.

          Parameters:
          @@ -1632,7 +1632,7 @@

          Other Functions
          -sympy.physics.mechanics.functions.angular_momentum(point, frame, *body)[source]
          +sympy.physics.mechanics.functions.angular_momentum(point, frame, *body)[source]

          Angular momentum of a system.

          Parameters:
          @@ -1681,7 +1681,7 @@

          Other Functions
          -sympy.physics.mechanics.functions.kinetic_energy(frame, *body)[source]
          +sympy.physics.mechanics.functions.kinetic_energy(frame, *body)[source]

          Kinetic energy of a multibody system.

          Parameters:
          @@ -1728,7 +1728,7 @@

          Other Functions
          -sympy.physics.mechanics.functions.potential_energy(*body)[source]
          +sympy.physics.mechanics.functions.potential_energy(*body)[source]

          Potential energy of a multibody system.

          Parameters:
          @@ -1771,7 +1771,7 @@

          Other Functions
          -sympy.physics.mechanics.functions.Lagrangian(frame, *body)[source]
          +sympy.physics.mechanics.functions.Lagrangian(frame, *body)[source]

          Lagrangian of a multibody system.

          Parameters:
          @@ -1829,7 +1829,7 @@

          Other Functionsreference_frame=None,

          -)[source] +)[source]

          Find all dynamicsymbols in expression.

          Parameters:
          diff --git a/dev/modules/physics/mechanics/api/pathway.html b/dev/modules/physics/mechanics/api/pathway.html index a1b62a4f632..29583022c66 100644 --- a/dev/modules/physics/mechanics/api/pathway.html +++ b/dev/modules/physics/mechanics/api/pathway.html @@ -806,7 +806,7 @@
          Documentation Version

          Implementations of pathways for use by actuators.

          -class sympy.physics.mechanics.pathway.LinearPathway(*attachments)[source]
          +class sympy.physics.mechanics.pathway.LinearPathway(*attachments)[source]

          Linear pathway between a pair of attachment points.

          Parameters:
          @@ -896,7 +896,7 @@
          Documentation Version
          -to_loads(force)[source]
          +to_loads(force)[source]

          Loads required by the equations of motion method classes.

          Parameters:
          @@ -950,7 +950,7 @@
          Documentation Version
          -class sympy.physics.mechanics.pathway.ObstacleSetPathway(*attachments)[source]
          +class sympy.physics.mechanics.pathway.ObstacleSetPathway(*attachments)[source]

          Obstacle-set pathway between a set of attachment points.

          Parameters:
          @@ -1031,7 +1031,7 @@
          Documentation Version
          -to_loads(force)[source]
          +to_loads(force)[source]

          Loads required by the equations of motion method classes.

          Parameters:
          @@ -1098,7 +1098,7 @@
          Documentation Version
          -class sympy.physics.mechanics.pathway.PathwayBase(*attachments)[source]
          +class sympy.physics.mechanics.pathway.PathwayBase(*attachments)[source]

          Abstract base class for all pathway classes to inherit from.

          Notes

          Instances of this class cannot be directly instantiated by users. However, @@ -1123,7 +1123,7 @@

          Documentation Version
          -abstract to_loads(force)[source]
          +abstract to_loads(force)[source]

          Loads required by the equations of motion method classes.

          Explanation

          KanesMethod requires a list of Point-Vector tuples to be @@ -1148,7 +1148,7 @@

          Documentation Version
          geometry,
          -)[source] +)[source]

          Pathway that wraps a geometry object.

          Parameters:
          @@ -1235,7 +1235,7 @@
          Documentation Version
          -to_loads(force)[source]
          +to_loads(force)[source]

          Loads required by the equations of motion method classes.

          Parameters:
          diff --git a/dev/modules/physics/mechanics/api/system.html b/dev/modules/physics/mechanics/api/system.html index 22ade6ab860..07bfa8efa1d 100644 --- a/dev/modules/physics/mechanics/api/system.html +++ b/dev/modules/physics/mechanics/api/system.html @@ -821,7 +821,7 @@

          System (Docstrings)loads=None,

          -)[source] +)[source]

          SymbolicSystem is a class that contains all the information about a system in a symbolic format such as the equations of motions and the bodies and loads in the system.

          @@ -1023,7 +1023,7 @@

          System (Docstrings)
          -compute_explicit_form()[source]
          +compute_explicit_form()[source]

          If the explicit right hand side of the combined equations of motion is to provided upon initialization, this method will calculate it. This calculation can potentially take awhile to compute.

          @@ -1031,7 +1031,7 @@

          System (Docstrings)
          -constant_symbols()[source]
          +constant_symbols()[source]

          Returns a column matrix containing all of the symbols in the system that do not depend on time

          @@ -1060,7 +1060,7 @@

          System (Docstrings)
          -dynamic_symbols()[source]
          +dynamic_symbols()[source]

          Returns a column matrix containing all of the symbols in the system that depend on time

          @@ -1094,7 +1094,7 @@

          System (Docstrings)
          -class sympy.physics.mechanics.system.System(frame=None, fixed_point=None)[source]
          +class sympy.physics.mechanics.system.System(frame=None, fixed_point=None)[source]

          Class to define a multibody system and form its equations of motion.

          Explanation

          A System instance stores the different objects associated with a model, @@ -1309,7 +1309,7 @@

          System (Docstrings)
          -add_actuators(*actuators)[source]
          +add_actuators(*actuators)[source]

          Add actuator(s) to the system.

          Parameters:
          @@ -1323,7 +1323,7 @@

          System (Docstrings)
          -add_auxiliary_speeds(*speeds)[source]
          +add_auxiliary_speeds(*speeds)[source]

          Add auxiliary speed(s) to the system.

          Parameters:
          @@ -1337,7 +1337,7 @@

          System (Docstrings)
          -add_bodies(*bodies)[source]
          +add_bodies(*bodies)[source]

          Add body(ies) to the system.

          Parameters:
          @@ -1358,7 +1358,7 @@

          System (Docstrings)independent=True,

          -)[source] +)[source]

          Add generalized coordinate(s) to the system.

          Parameters:
          @@ -1378,7 +1378,7 @@

          System (Docstrings)
          -add_holonomic_constraints(*constraints)[source]
          +add_holonomic_constraints(*constraints)[source]

          Add holonomic constraint(s) to the system.

          Parameters:
          @@ -1393,7 +1393,7 @@

          System (Docstrings)
          -add_joints(*joints)[source]
          +add_joints(*joints)[source]

          Add joint(s) to the system.

          Parameters:
          @@ -1417,7 +1417,7 @@

          System (Docstrings)
          -add_kdes(*kdes)[source]
          +add_kdes(*kdes)[source]

          Add kinematic differential equation(s) to the system.

          Parameters:
          @@ -1431,7 +1431,7 @@

          System (Docstrings)
          -add_loads(*loads)[source]
          +add_loads(*loads)[source]

          Add load(s) to the system.

          Parameters:
          @@ -1445,7 +1445,7 @@

          System (Docstrings)
          -add_nonholonomic_constraints(*constraints)[source]
          +add_nonholonomic_constraints(*constraints)[source]

          Add nonholonomic constraint(s) to the system.

          Parameters:
          @@ -1460,7 +1460,7 @@

          System (Docstrings)
          -add_speeds(*speeds, independent=True)[source]
          +add_speeds(*speeds, independent=True)[source]

          Add generalized speed(s) to the system.

          Parameters:
          @@ -1479,7 +1479,7 @@

          System (Docstrings)
          -apply_uniform_gravity(acceleration)[source]
          +apply_uniform_gravity(acceleration)[source]

          Apply uniform gravity to all bodies in the system by adding loads.

          Parameters:
          @@ -1531,7 +1531,7 @@

          System (Docstrings)**kwargs,

          -)[source] +)[source]

          Form the equations of motion of the system.

          Parameters:
          @@ -1585,13 +1585,13 @@

          System (Docstrings)
          -classmethod from_newtonian(newtonian)[source]
          +classmethod from_newtonian(newtonian)[source]

          Constructs the system with respect to a Newtonian body.

          -get_body(name)[source]
          +get_body(name)[source]

          Retrieve a body from the system by name.

          Parameters:
          @@ -1611,7 +1611,7 @@

          System (Docstrings)
          -get_joint(name)[source]
          +get_joint(name)[source]

          Retrieve a joint from the system by name.

          Parameters:
          @@ -1714,7 +1714,7 @@

          System (Docstrings)
          -rhs(inv_method=None)[source]
          +rhs(inv_method=None)[source]

          Compute the equations of motion in the explicit form.

          Parameters:
          @@ -1777,7 +1777,7 @@

          System (Docstrings)check_duplicates=False,

          -)[source] +)[source]

          Validates the system using some basic checks.

          Parameters:
          diff --git a/dev/modules/physics/mechanics/api/wrapping_geometry.html b/dev/modules/physics/mechanics/api/wrapping_geometry.html index 064b5fdb84e..4e60e1fe676 100644 --- a/dev/modules/physics/mechanics/api/wrapping_geometry.html +++ b/dev/modules/physics/mechanics/api/wrapping_geometry.html @@ -806,7 +806,7 @@
          Documentation Version

          Geometry objects for use by wrapping pathways.

          -class sympy.physics.mechanics.wrapping_geometry.WrappingCylinder(radius, point, axis)[source]
          +class sympy.physics.mechanics.wrapping_geometry.WrappingCylinder(radius, point, axis)[source]

          A solid (infinite) cylindrical object.

          Parameters:
          @@ -873,7 +873,7 @@
          Documentation Version
          point_2,
          -)[source] +)[source]

          The vectors parallel to the geodesic at the two end points.

          Parameters:
          @@ -891,7 +891,7 @@
          Documentation Version
          -geodesic_length(point_1, point_2)[source]
          +geodesic_length(point_1, point_2)[source]

          The shortest distance between two points on a geometry’s surface.

          Parameters:
          @@ -964,7 +964,7 @@
          Documentation Version
          -point_on_surface(point)[source]
          +point_on_surface(point)[source]

          Returns True if a point is on the cylinder’s surface.

          Parameters:
          @@ -989,7 +989,7 @@
          Documentation Version
          -class sympy.physics.mechanics.wrapping_geometry.WrappingGeometryBase[source]
          +class sympy.physics.mechanics.wrapping_geometry.WrappingGeometryBase[source]

          Abstract base class for all geometry classes to inherit from.

          Notes

          Instances of this class cannot be directly instantiated by users. However, @@ -1003,7 +1003,7 @@

          Documentation Version
          point_2,
          -)[source] +)[source]

          The vectors parallel to the geodesic at the two end points.

          Parameters:
          @@ -1028,7 +1028,7 @@
          Documentation Version
          point_2,
          -)[source] +)[source]

          Returns the shortest distance between two points on a geometry’s surface.

          @@ -1053,7 +1053,7 @@
          Documentation Version
          -abstract point_on_surface(point)[source]
          +abstract point_on_surface(point)[source]

          Returns True if a point is on the geometry’s surface.

          Parameters:
          @@ -1070,7 +1070,7 @@
          Documentation Version
          -class sympy.physics.mechanics.wrapping_geometry.WrappingSphere(radius, point)[source]
          +class sympy.physics.mechanics.wrapping_geometry.WrappingSphere(radius, point)[source]

          A solid spherical object.

          Parameters:
          @@ -1119,7 +1119,7 @@
          Documentation Version
          point_2,
          -)[source] +)[source]

          The vectors parallel to the geodesic at the two end points.

          Parameters:
          @@ -1137,7 +1137,7 @@
          Documentation Version
          -geodesic_length(point_1, point_2)[source]
          +geodesic_length(point_1, point_2)[source]

          Returns the shortest distance between two points on the sphere’s surface.

          @@ -1210,7 +1210,7 @@
          Documentation Version
          -point_on_surface(point)[source]
          +point_on_surface(point)[source]

          Returns True if a point is on the sphere’s surface.

          Parameters:
          diff --git a/dev/modules/physics/optics/gaussopt.html b/dev/modules/physics/optics/gaussopt.html index c6883800bd6..2147a4a49fb 100644 --- a/dev/modules/physics/optics/gaussopt.html +++ b/dev/modules/physics/optics/gaussopt.html @@ -824,7 +824,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.BeamParameter(wavelen, z, z_r=None, w=None, n=1)[source]
          +class sympy.physics.optics.gaussopt.BeamParameter(wavelen, z, z_r=None, w=None, n=1)[source]

          Representation for a gaussian ray in the Ray Transfer Matrix formalism.

          Parameters:
          @@ -989,7 +989,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.CurvedMirror(R)[source]
          +class sympy.physics.optics.gaussopt.CurvedMirror(R)[source]

          Ray Transfer Matrix for reflection from curved surface.

          Parameters:
          @@ -1014,7 +1014,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.CurvedRefraction(R, n1, n2)[source]
          +class sympy.physics.optics.gaussopt.CurvedRefraction(R, n1, n2)[source]

          Ray Transfer Matrix for refraction on curved interface.

          Parameters:
          @@ -1050,7 +1050,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.FlatMirror[source]
          +class sympy.physics.optics.gaussopt.FlatMirror[source]

          Ray Transfer Matrix for reflection.

          Examples

          >>> from sympy.physics.optics import FlatMirror
          @@ -1068,7 +1068,7 @@ 
          Documentation Version
          -class sympy.physics.optics.gaussopt.FlatRefraction(n1, n2)[source]
          +class sympy.physics.optics.gaussopt.FlatRefraction(n1, n2)[source]

          Ray Transfer Matrix for refraction.

          Parameters:
          @@ -1100,7 +1100,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.FreeSpace(d)[source]
          +class sympy.physics.optics.gaussopt.FreeSpace(d)[source]

          Ray Transfer Matrix for free space.

          Parameters:
          @@ -1125,7 +1125,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.GeometricRay(*args)[source]
          +class sympy.physics.optics.gaussopt.GeometricRay(*args)[source]

          Representation for a geometric ray in the Ray Transfer Matrix formalism.

          Parameters:
          @@ -1196,7 +1196,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.RayTransferMatrix(*args)[source]
          +class sympy.physics.optics.gaussopt.RayTransferMatrix(*args)[source]

          Base class for a Ray Transfer Matrix.

          It should be used if there is not already a more specific subclass mentioned in See Also.

          @@ -1309,7 +1309,7 @@
          Documentation Version
          -class sympy.physics.optics.gaussopt.ThinLens(f)[source]
          +class sympy.physics.optics.gaussopt.ThinLens(f)[source]

          Ray Transfer Matrix for a thin lens.

          Parameters:
          @@ -1346,7 +1346,7 @@
          Documentation Version
          **kwargs,
          -)[source] +)[source]

          Find the optical setup conjugating the object/image waists.

          Parameters:
          @@ -1402,7 +1402,7 @@
          Documentation Version
          -sympy.physics.optics.gaussopt.gaussian_conj(s_in, z_r_in, f)[source]
          +sympy.physics.optics.gaussopt.gaussian_conj(s_in, z_r_in, f)[source]

          Conjugation relation for gaussian beams.

          Parameters:
          @@ -1457,7 +1457,7 @@
          Documentation Version
          -sympy.physics.optics.gaussopt.geometric_conj_ab(a, b)[source]
          +sympy.physics.optics.gaussopt.geometric_conj_ab(a, b)[source]

          Conjugation relation for geometrical beams under paraxial conditions.

          Explanation

          Takes the distances to the optical element and returns the needed @@ -1478,7 +1478,7 @@

          Documentation Version
          -sympy.physics.optics.gaussopt.geometric_conj_af(a, f)[source]
          +sympy.physics.optics.gaussopt.geometric_conj_af(a, f)[source]

          Conjugation relation for geometrical beams under paraxial conditions.

          Explanation

          Takes the object distance (for geometric_conj_af) or the image distance @@ -1502,7 +1502,7 @@

          Documentation Version
          -sympy.physics.optics.gaussopt.geometric_conj_bf(a, f)[source]
          +sympy.physics.optics.gaussopt.geometric_conj_bf(a, f)[source]

          Conjugation relation for geometrical beams under paraxial conditions.

          Explanation

          Takes the object distance (for geometric_conj_af) or the image distance @@ -1526,7 +1526,7 @@

          Documentation Version
          -sympy.physics.optics.gaussopt.rayleigh2waist(z_r, wavelen)[source]
          +sympy.physics.optics.gaussopt.rayleigh2waist(z_r, wavelen)[source]

          Calculate the waist from the rayleigh range of a gaussian beam.

          Examples

          >>> from sympy.physics.optics import rayleigh2waist
          @@ -1544,7 +1544,7 @@ 
          Documentation Version
          -sympy.physics.optics.gaussopt.waist2rayleigh(w, wavelen, n=1)[source]
          +sympy.physics.optics.gaussopt.waist2rayleigh(w, wavelen, n=1)[source]

          Calculate the rayleigh range from the waist of a gaussian beam.

          Examples

          >>> from sympy.physics.optics import waist2rayleigh
          diff --git a/dev/modules/physics/optics/medium.html b/dev/modules/physics/optics/medium.html
          index 9f20105ba86..02e4d93d4b8 100644
          --- a/dev/modules/physics/optics/medium.html
          +++ b/dev/modules/physics/optics/medium.html
          @@ -818,7 +818,7 @@ 
          Documentation Version
          n=None,
          -)[source] +)[source]

          This class represents an optical medium. The prime reason to implement this is to facilitate refraction, Fermat’s principle, etc.

          diff --git a/dev/modules/physics/optics/polarization.html b/dev/modules/physics/optics/polarization.html index cec71df021b..c1f5094ed9c 100644 --- a/dev/modules/physics/optics/polarization.html +++ b/dev/modules/physics/optics/polarization.html @@ -893,7 +893,7 @@

          References
          -sympy.physics.optics.polarization.half_wave_retarder(theta)[source]
          +sympy.physics.optics.polarization.half_wave_retarder(theta)[source]

          A half-wave retarder Jones matrix at angle theta.

          Parameters:
          @@ -927,7 +927,7 @@

          References
          -sympy.physics.optics.polarization.jones_2_stokes(e)[source]
          +sympy.physics.optics.polarization.jones_2_stokes(e)[source]

          Return the Stokes vector for a Jones vector e.

          Parameters:
          @@ -969,7 +969,7 @@

          References
          -sympy.physics.optics.polarization.jones_vector(psi, chi)[source]
          +sympy.physics.optics.polarization.jones_vector(psi, chi)[source]

          A Jones vector corresponding to a polarization ellipse with \(psi\) tilt, and \(chi\) circularity.

          @@ -1066,7 +1066,7 @@

          References
          -sympy.physics.optics.polarization.linear_polarizer(theta=0)[source]
          +sympy.physics.optics.polarization.linear_polarizer(theta=0)[source]

          A linear polarizer Jones matrix with transmission axis at an angle theta.

          @@ -1101,7 +1101,7 @@

          References
          -sympy.physics.optics.polarization.mueller_matrix(J)[source]
          +sympy.physics.optics.polarization.mueller_matrix(J)[source]

          The Mueller matrix corresponding to Jones matrix \(J\).

          Parameters:
          @@ -1174,7 +1174,7 @@

          References
          -sympy.physics.optics.polarization.phase_retarder(theta=0, delta=0)[source]
          +sympy.physics.optics.polarization.phase_retarder(theta=0, delta=0)[source]

          A phase retarder Jones matrix with retardance delta at angle theta.

          Parameters:
          @@ -1228,7 +1228,7 @@

          Referencesphib=0,

          -)[source] +)[source]

          A polarizing beam splitter Jones matrix at angle \(theta\).

          Parameters:
          @@ -1297,7 +1297,7 @@

          References
          -sympy.physics.optics.polarization.quarter_wave_retarder(theta)[source]
          +sympy.physics.optics.polarization.quarter_wave_retarder(theta)[source]

          A quarter-wave retarder Jones matrix at angle theta.

          Parameters:
          @@ -1335,7 +1335,7 @@

          References
          -sympy.physics.optics.polarization.reflective_filter(R)[source]
          +sympy.physics.optics.polarization.reflective_filter(R)[source]

          A reflective filter Jones matrix with reflectance R.

          Parameters:
          @@ -1366,7 +1366,7 @@

          References
          -sympy.physics.optics.polarization.stokes_vector(psi, chi, p=1, I=1)[source]
          +sympy.physics.optics.polarization.stokes_vector(psi, chi, p=1, I=1)[source]

          A Stokes vector corresponding to a polarization ellipse with psi tilt, and chi circularity.

          @@ -1491,7 +1491,7 @@

          References
          -sympy.physics.optics.polarization.transmissive_filter(T)[source]
          +sympy.physics.optics.polarization.transmissive_filter(T)[source]

          An attenuator Jones matrix with transmittance T.

          Parameters:
          diff --git a/dev/modules/physics/optics/utils.html b/dev/modules/physics/optics/utils.html index 216d159083f..b04441b0a22 100644 --- a/dev/modules/physics/optics/utils.html +++ b/dev/modules/physics/optics/utils.html @@ -818,7 +818,7 @@
          Documentation Version

        -sympy.physics.optics.utils.brewster_angle(medium1, medium2)[source]
        +sympy.physics.optics.utils.brewster_angle(medium1, medium2)[source]

        This function calculates the Brewster’s angle of incidence to Medium 2 from Medium 1 in radians.

        @@ -843,7 +843,7 @@
        Documentation Version
        -sympy.physics.optics.utils.critical_angle(medium1, medium2)[source]
        +sympy.physics.optics.utils.critical_angle(medium1, medium2)[source]

        This function calculates the critical angle of incidence (marking the onset of total internal) to Medium 2 from Medium 1 in radians.

        @@ -878,7 +878,7 @@
        Documentation Version
        plane=None,
        -)[source] +)[source]

        This function calculates the angle of deviation of a ray due to refraction at planar surface.

        @@ -935,7 +935,7 @@
        Documentation Version
        medium2,
        -)[source] +)[source]

        This function uses Fresnel equations to calculate reflection and transmission coefficients. Those are obtained for both polarisations when the electric field vector is in the plane of incidence (labelled ‘p’) @@ -987,7 +987,7 @@

        Documentation Version
        -sympy.physics.optics.utils.hyperfocal_distance(f, N, c)[source]
        +sympy.physics.optics.utils.hyperfocal_distance(f, N, c)[source]
        Parameters:

        f: sympifiable

        @@ -1014,7 +1014,7 @@
        Documentation Version
        -sympy.physics.optics.utils.lens_formula(focal_length=None, u=None, v=None)[source]
        +sympy.physics.optics.utils.lens_formula(focal_length=None, u=None, v=None)[source]

        This function provides one of the three parameters when two of them are supplied. This is valid only for paraxial rays.

        @@ -1051,7 +1051,7 @@
        Documentation Version
        -sympy.physics.optics.utils.lens_makers_formula(n_lens, n_surr, r1, r2, d=0)[source]
        +sympy.physics.optics.utils.lens_makers_formula(n_lens, n_surr, r1, r2, d=0)[source]

        This function calculates focal length of a lens. It follows cartesian sign convention.

        @@ -1093,7 +1093,7 @@
        Documentation Version
        -sympy.physics.optics.utils.mirror_formula(focal_length=None, u=None, v=None)[source]
        +sympy.physics.optics.utils.mirror_formula(focal_length=None, u=None, v=None)[source]

        This function provides one of the three parameters when two of them are supplied. This is valid only for paraxial rays.

        @@ -1140,7 +1140,7 @@
        Documentation Version
        plane=None,
        -)[source] +)[source]

        This function calculates transmitted vector after refraction at planar surface. medium1 and medium2 can be Medium or any sympifiable object. If incident is a number then treated as angle of incidence (in radians) @@ -1214,7 +1214,7 @@

        Documentation Version
        -sympy.physics.optics.utils.transverse_magnification(si, so)[source]
        +sympy.physics.optics.utils.transverse_magnification(si, so)[source]

        Calculates the transverse magnification upon reflection in a mirror, which is the ratio of the image size to the object size.

        diff --git a/dev/modules/physics/optics/waves.html b/dev/modules/physics/optics/waves.html index c0d62e9a310..bf74a981247 100644 --- a/dev/modules/physics/optics/waves.html +++ b/dev/modules/physics/optics/waves.html @@ -820,7 +820,7 @@
        Documentation Version
        n=n,
        -)[source] +)[source]

        This is a simple transverse sine wave travelling in a one-dimensional space. Basic properties are required at the time of creation of the object, but they can be changed later with respective methods provided.

        diff --git a/dev/modules/physics/paulialgebra.html b/dev/modules/physics/paulialgebra.html index 83ceea7caea..9ef079cd894 100644 --- a/dev/modules/physics/paulialgebra.html +++ b/dev/modules/physics/paulialgebra.html @@ -817,7 +817,7 @@

        References
        -sympy.physics.paulialgebra.evaluate_pauli_product(arg)[source]
        +sympy.physics.paulialgebra.evaluate_pauli_product(arg)[source]

        Help function to evaluate Pauli matrices product with symbolic objects.

        diff --git a/dev/modules/physics/qho_1d.html b/dev/modules/physics/qho_1d.html index 32b3520e6e6..3c7ee61f1a4 100644 --- a/dev/modules/physics/qho_1d.html +++ b/dev/modules/physics/qho_1d.html @@ -805,7 +805,7 @@
        Documentation Version

        Quantum Harmonic Oscillator in 1-D

        -sympy.physics.qho_1d.E_n(n, omega)[source]
        +sympy.physics.qho_1d.E_n(n, omega)[source]

        Returns the Energy of the One-dimensional harmonic oscillator.

        Parameters:
        @@ -836,7 +836,7 @@
        Documentation Version
        -sympy.physics.qho_1d.coherent_state(n, alpha)[source]
        +sympy.physics.qho_1d.coherent_state(n, alpha)[source]

        Returns <n|alpha> for the coherent states of 1D harmonic oscillator. See https://en.wikipedia.org/wiki/Coherent_states

        @@ -855,7 +855,7 @@
        Documentation Version
        -sympy.physics.qho_1d.psi_n(n, x, m, omega)[source]
        +sympy.physics.qho_1d.psi_n(n, x, m, omega)[source]

        Returns the wavefunction psi_{n} for the One-dimensional harmonic oscillator.

        Parameters:
        diff --git a/dev/modules/physics/quantum/anticommutator.html b/dev/modules/physics/quantum/anticommutator.html index 162fc04bce5..00e9f881dca 100644 --- a/dev/modules/physics/quantum/anticommutator.html +++ b/dev/modules/physics/quantum/anticommutator.html @@ -806,7 +806,7 @@
        Documentation Version

        The anti-commutator: {A,B} = A*B + B*A.

        -class sympy.physics.quantum.anticommutator.AntiCommutator(A, B)[source]
        +class sympy.physics.quantum.anticommutator.AntiCommutator(A, B)[source]

        The standard anticommutator, in an unevaluated state.

        Parameters:
        @@ -869,7 +869,7 @@
        Documentation Version

        -doit(**hints)[source]
        +doit(**hints)[source]

        Evaluate anticommutator

        diff --git a/dev/modules/physics/quantum/cartesian.html b/dev/modules/physics/quantum/cartesian.html index 40a77770444..c8fe1f1db46 100644 --- a/dev/modules/physics/quantum/cartesian.html +++ b/dev/modules/physics/quantum/cartesian.html @@ -810,19 +810,19 @@
        Documentation Version

    -class sympy.physics.quantum.cartesian.PositionBra3D(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.PositionBra3D(*args, **kwargs)[source]

    3D cartesian position eigenbra

    -class sympy.physics.quantum.cartesian.PositionKet3D(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.PositionKet3D(*args, **kwargs)[source]

    3D cartesian position eigenket

    -class sympy.physics.quantum.cartesian.PositionState3D(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.PositionState3D(*args, **kwargs)[source]

    Base class for 3D cartesian position eigenstates

    @@ -846,7 +846,7 @@
    Documentation Version
    -class sympy.physics.quantum.cartesian.PxBra(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.PxBra(*args, **kwargs)[source]

    1D cartesian momentum eigenbra.

    @@ -858,7 +858,7 @@
    Documentation Version
    -class sympy.physics.quantum.cartesian.PxKet(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.PxKet(*args, **kwargs)[source]

    1D cartesian momentum eigenket.

    @@ -870,13 +870,13 @@
    Documentation Version
    -class sympy.physics.quantum.cartesian.PxOp(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.PxOp(*args, **kwargs)[source]

    1D cartesian momentum operator.

    -class sympy.physics.quantum.cartesian.XBra(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.XBra(*args, **kwargs)[source]

    1D cartesian position eigenbra.

    @@ -888,7 +888,7 @@
    Documentation Version
    -class sympy.physics.quantum.cartesian.XKet(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.XKet(*args, **kwargs)[source]

    1D cartesian position eigenket.

    @@ -900,19 +900,19 @@
    Documentation Version
    -class sympy.physics.quantum.cartesian.XOp(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.XOp(*args, **kwargs)[source]

    1D cartesian position operator.

    -class sympy.physics.quantum.cartesian.YOp(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.YOp(*args, **kwargs)[source]

    Y cartesian coordinate operator (for 2D or 3D systems)

    -class sympy.physics.quantum.cartesian.ZOp(*args, **kwargs)[source]
    +class sympy.physics.quantum.cartesian.ZOp(*args, **kwargs)[source]

    Z cartesian coordinate operator (for 3D systems)

    diff --git a/dev/modules/physics/quantum/cg.html b/dev/modules/physics/quantum/cg.html index 569b3bd0ab5..79f09cec277 100644 --- a/dev/modules/physics/quantum/cg.html +++ b/dev/modules/physics/quantum/cg.html @@ -806,7 +806,7 @@
    Documentation Version

    Clebsch-Gordon Coefficients.

    -class sympy.physics.quantum.cg.CG(j1, m1, j2, m2, j3, m3)[source]
    +class sympy.physics.quantum.cg.CG(j1, m1, j2, m2, j3, m3)[source]

    Class for Clebsch-Gordan coefficient.

    Parameters:
    @@ -869,7 +869,7 @@
    Documentation Version
    -class sympy.physics.quantum.cg.Wigner3j(j1, m1, j2, m2, j3, m3)[source]
    +class sympy.physics.quantum.cg.Wigner3j(j1, m1, j2, m2, j3, m3)[source]

    Class for the Wigner-3j symbols.

    Parameters:
    @@ -914,7 +914,7 @@
    Documentation Version
    -class sympy.physics.quantum.cg.Wigner6j(j1, j2, j12, j3, j, j23)[source]
    +class sympy.physics.quantum.cg.Wigner6j(j1, j2, j12, j3, j, j23)[source]

    Class for the Wigner-6j symbols

    See also

    @@ -927,7 +927,7 @@
    Documentation Version
    -class sympy.physics.quantum.cg.Wigner9j(j1, j2, j12, j3, j4, j34, j13, j24, j)[source]
    +class sympy.physics.quantum.cg.Wigner9j(j1, j2, j12, j3, j4, j34, j13, j24, j)[source]

    Class for the Wigner-9j symbols

    See also

    @@ -940,7 +940,7 @@
    Documentation Version
    -sympy.physics.quantum.cg.cg_simp(e)[source]
    +sympy.physics.quantum.cg.cg_simp(e)[source]

    Simplify and combine CG coefficients.

    Explanation

    This function uses various symmetry and properties of sums and diff --git a/dev/modules/physics/quantum/circuitplot.html b/dev/modules/physics/quantum/circuitplot.html index 4b8cfe71a1f..4f1202cd705 100644 --- a/dev/modules/physics/quantum/circuitplot.html +++ b/dev/modules/physics/quantum/circuitplot.html @@ -819,7 +819,7 @@

    Documentation Version

-class sympy.physics.quantum.circuitplot.CircuitPlot(c, nqubits, **kwargs)[source]
+class sympy.physics.quantum.circuitplot.CircuitPlot(c, nqubits, **kwargs)[source]

A class for managing a circuit plot.

@@ -831,43 +831,43 @@
Documentation Version
max_wire,
-)[source] +)[source]

Draw a vertical control line.

-control_point(gate_idx, wire_idx)[source]
+control_point(gate_idx, wire_idx)[source]

Draw a control point.

-not_point(gate_idx, wire_idx)[source]
+not_point(gate_idx, wire_idx)[source]

Draw a NOT gates as the circle with plus in the middle.

-one_qubit_box(t, gate_idx, wire_idx)[source]
+one_qubit_box(t, gate_idx, wire_idx)[source]

Draw a box for a single qubit gate.

-swap_point(gate_idx, wire_idx)[source]
+swap_point(gate_idx, wire_idx)[source]

Draw a swap point as a cross.

-two_qubit_box(t, gate_idx, wire_idx)[source]
+two_qubit_box(t, gate_idx, wire_idx)[source]

Draw a box for a two qubit gate. Does not work yet.

-update(kwargs)[source]
+update(kwargs)[source]

Load the kwargs into the instance dict.

@@ -875,13 +875,13 @@
Documentation Version
-sympy.physics.quantum.circuitplot.CreateCGate(name, latexname=None)[source]
+sympy.physics.quantum.circuitplot.CreateCGate(name, latexname=None)[source]

Use a lexical closure to make a controlled gate.

-class sympy.physics.quantum.circuitplot.Mx(*args, **kwargs)[source]
+class sympy.physics.quantum.circuitplot.Mx(*args, **kwargs)[source]

Mock-up of an x measurement gate.

This is in circuitplot rather than gate.py because it’s not a real gate, it just draws one.

@@ -889,7 +889,7 @@
Documentation Version
-class sympy.physics.quantum.circuitplot.Mz(*args, **kwargs)[source]
+class sympy.physics.quantum.circuitplot.Mz(*args, **kwargs)[source]

Mock-up of a z measurement gate.

This is in circuitplot rather than gate.py because it’s not a real gate, it just draws one.

@@ -897,7 +897,7 @@
Documentation Version
-sympy.physics.quantum.circuitplot.circuit_plot(c, nqubits, **kwargs)[source]
+sympy.physics.quantum.circuitplot.circuit_plot(c, nqubits, **kwargs)[source]

Draw the circuit diagram for the circuit with nqubits.

Parameters:
@@ -916,7 +916,7 @@
Documentation Version
-sympy.physics.quantum.circuitplot.labeller(n, symbol='q')[source]
+sympy.physics.quantum.circuitplot.labeller(n, symbol='q')[source]

Autogenerate labels for wires of quantum circuits.

Parameters:
diff --git a/dev/modules/physics/quantum/commutator.html b/dev/modules/physics/quantum/commutator.html index b75d42d048d..3ff5ba0d807 100644 --- a/dev/modules/physics/quantum/commutator.html +++ b/dev/modules/physics/quantum/commutator.html @@ -806,7 +806,7 @@
Documentation Version

The commutator: [A,B] = A*B - B*A.

-class sympy.physics.quantum.commutator.Commutator(A, B)[source]
+class sympy.physics.quantum.commutator.Commutator(A, B)[source]

The standard commutator, in an unevaluated state.

Parameters:
@@ -881,7 +881,7 @@
Documentation Version

-doit(**hints)[source]
+doit(**hints)[source]

Evaluate commutator

diff --git a/dev/modules/physics/quantum/constants.html b/dev/modules/physics/quantum/constants.html index 56799d05a0f..13e68c4b7b3 100644 --- a/dev/modules/physics/quantum/constants.html +++ b/dev/modules/physics/quantum/constants.html @@ -806,7 +806,7 @@
Documentation Version

Constants (like hbar) related to quantum mechanics.

-class sympy.physics.quantum.constants.HBar[source]
+class sympy.physics.quantum.constants.HBar[source]

Reduced Plank’s constant in numerical and symbolic form [R763].

Examples

>>> from sympy.physics.quantum.constants import hbar
diff --git a/dev/modules/physics/quantum/dagger.html b/dev/modules/physics/quantum/dagger.html
index 8b0b5158dbe..c76aaaf50e1 100644
--- a/dev/modules/physics/quantum/dagger.html
+++ b/dev/modules/physics/quantum/dagger.html
@@ -806,7 +806,7 @@ 
Documentation Version

Hermitian conjugation.

-class sympy.physics.quantum.dagger.Dagger(arg)[source]
+class sympy.physics.quantum.dagger.Dagger(arg)[source]

General Hermitian conjugate operation.

Parameters:
diff --git a/dev/modules/physics/quantum/gate.html b/dev/modules/physics/quantum/gate.html index 1f7edc2d20c..d93dbb42bd5 100644 --- a/dev/modules/physics/quantum/gate.html +++ b/dev/modules/physics/quantum/gate.html @@ -817,7 +817,7 @@
Documentation Version
-class sympy.physics.quantum.gate.CGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.CGate(*args, **kwargs)[source]

A general unitary gate with control qubits.

A general control gate applies a target gate to a set of targets if all of the control qubits have a particular values (set by @@ -840,13 +840,13 @@

Documentation Version
-decompose(**options)[source]
+decompose(**options)[source]

Decompose the controlled gate into CNOT and single qubits gates.

-eval_controls(qubit)[source]
+eval_controls(qubit)[source]

Return True/False to indicate if the controls are satisfied.

@@ -872,7 +872,7 @@
Documentation Version
-plot_gate(circ_plot, gate_idx)[source]
+plot_gate(circ_plot, gate_idx)[source]

Plot the controlled gate. If simplify_cgate is true, simplify C-X and C-Z gates into their more familiar forms.

@@ -887,20 +887,20 @@
Documentation Version
-class sympy.physics.quantum.gate.CGateS(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.CGateS(*args, **kwargs)[source]

Version of CGate that allows gate simplifications. I.e. cnot looks like an oplus, cphase has dots, etc.

-sympy.physics.quantum.gate.CNOT[source]
+sympy.physics.quantum.gate.CNOT[source]

alias of CNotGate

-class sympy.physics.quantum.gate.CNotGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.CNotGate(*args, **kwargs)[source]

Two qubit controlled-NOT.

This gate performs the NOT or X gate on the target qubit if the control qubits all have the value 1.

@@ -949,7 +949,7 @@
Documentation Version
-class sympy.physics.quantum.gate.Gate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.Gate(*args, **kwargs)[source]

Non-controlled unitary gate operator that acts on qubits.

This is a general abstract gate that needs to be subclassed to do anything useful.

@@ -963,7 +963,7 @@
Documentation Version
-get_target_matrix(format='sympy')[source]
+get_target_matrix(format='sympy')[source]

The matrix representation of the target part of the gate.

Parameters:
@@ -999,13 +999,13 @@
Documentation Version
-sympy.physics.quantum.gate.H[source]
+sympy.physics.quantum.gate.H[source]

alias of HadamardGate

-class sympy.physics.quantum.gate.HadamardGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.HadamardGate(*args, **kwargs)[source]

The single qubit Hadamard gate.

Parameters:
@@ -1032,7 +1032,7 @@
Documentation Version
-class sympy.physics.quantum.gate.IdentityGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.IdentityGate(*args, **kwargs)[source]

The single qubit identity gate.

Parameters:
@@ -1046,19 +1046,19 @@
Documentation Version
-class sympy.physics.quantum.gate.OneQubitGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.OneQubitGate(*args, **kwargs)[source]

A single qubit unitary gate base class.

-sympy.physics.quantum.gate.Phase[source]
+sympy.physics.quantum.gate.Phase[source]

alias of PhaseGate

-class sympy.physics.quantum.gate.PhaseGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.PhaseGate(*args, **kwargs)[source]

The single qubit phase, or S, gate.

This gate rotates the phase of the state by pi/2 if the state is |1> and does nothing if the state is |0>.

@@ -1074,19 +1074,19 @@
Documentation Version
-sympy.physics.quantum.gate.S[source]
+sympy.physics.quantum.gate.S[source]

alias of PhaseGate

-sympy.physics.quantum.gate.SWAP[source]
+sympy.physics.quantum.gate.SWAP[source]

alias of SwapGate

-class sympy.physics.quantum.gate.SwapGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.SwapGate(*args, **kwargs)[source]

Two qubit SWAP gate.

This gate swap the values of the two qubits.

@@ -1099,7 +1099,7 @@
Documentation Version
-decompose(**options)[source]
+decompose(**options)[source]

Decompose the SWAP gate into CNOT gates.

@@ -1107,13 +1107,13 @@
Documentation Version
-sympy.physics.quantum.gate.T[source]
+sympy.physics.quantum.gate.T[source]

alias of TGate

-class sympy.physics.quantum.gate.TGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.TGate(*args, **kwargs)[source]

The single qubit pi/8 gate.

This gate rotates the phase of the state by pi/4 if the state is |1> and does nothing if the state is |0>.

@@ -1129,13 +1129,13 @@
Documentation Version
-class sympy.physics.quantum.gate.TwoQubitGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.TwoQubitGate(*args, **kwargs)[source]

A two qubit unitary gate base class.

-class sympy.physics.quantum.gate.UGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.UGate(*args, **kwargs)[source]

General gate specified by a set of targets and a target matrix.

Parameters:
@@ -1149,7 +1149,7 @@
Documentation Version
-get_target_matrix(format='sympy')[source]
+get_target_matrix(format='sympy')[source]

The matrix rep. of the target part of the gate.

Parameters:
@@ -1171,13 +1171,13 @@
Documentation Version
-sympy.physics.quantum.gate.X[source]
+sympy.physics.quantum.gate.X[source]

alias of XGate

-class sympy.physics.quantum.gate.XGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.XGate(*args, **kwargs)[source]

The single qubit X, or NOT, gate.

Parameters:
@@ -1191,13 +1191,13 @@
Documentation Version
-sympy.physics.quantum.gate.Y[source]
+sympy.physics.quantum.gate.Y[source]

alias of YGate

-class sympy.physics.quantum.gate.YGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.YGate(*args, **kwargs)[source]

The single qubit Y gate.

Parameters:
@@ -1211,13 +1211,13 @@
Documentation Version
-sympy.physics.quantum.gate.Z[source]
+sympy.physics.quantum.gate.Z[source]

alias of ZGate

-class sympy.physics.quantum.gate.ZGate(*args, **kwargs)[source]
+class sympy.physics.quantum.gate.ZGate(*args, **kwargs)[source]

The single qubit Z gate.

Parameters:
@@ -1231,7 +1231,7 @@
Documentation Version
-sympy.physics.quantum.gate.gate_simp(circuit)[source]
+sympy.physics.quantum.gate.gate_simp(circuit)[source]

Simplifies gates symbolically

It first sorts gates using gate_sort. It then applies basic simplification rules to the circuit, e.g., XGate**2 = Identity

@@ -1239,7 +1239,7 @@
Documentation Version
-sympy.physics.quantum.gate.gate_sort(circuit)[source]
+sympy.physics.quantum.gate.gate_sort(circuit)[source]

Sorts the gates while keeping track of commutation relations

This function uses a bubble sort to rearrange the order of gate application. Keeps track of Quantum computations special commutation @@ -1250,7 +1250,7 @@

Documentation Version
-sympy.physics.quantum.gate.normalized(normalize)[source]
+sympy.physics.quantum.gate.normalized(normalize)[source]

Set flag controlling normalization of Hadamard gates by \(1/\sqrt{2}\).

This is a global setting that can be used to simplify the look of various expressions, by leaving off the leading \(1/\sqrt{2}\) of the Hadamard gate.

@@ -1283,7 +1283,7 @@
Documentation Version
<class 'sympy.physics.quantum.gate.SwapGate'>),
-)[source] +)[source]

Return a random circuit of ngates and nqubits.

This uses an equally weighted sample of (X, Y, Z, S, T, H, CNOT, SWAP) gates.

diff --git a/dev/modules/physics/quantum/grover.html b/dev/modules/physics/quantum/grover.html index c4fac3b612b..d497267a6bc 100644 --- a/dev/modules/physics/quantum/grover.html +++ b/dev/modules/physics/quantum/grover.html @@ -813,7 +813,7 @@
Documentation Version
-class sympy.physics.quantum.grover.OracleGate(*args, **kwargs)[source]
+class sympy.physics.quantum.grover.OracleGate(*args, **kwargs)[source]

A black box gate.

The gate marks the desired qubits of an unknown function by flipping the sign of the qubits. The unknown function returns true when it @@ -859,7 +859,7 @@

Documentation Version
-class sympy.physics.quantum.grover.WGate(*args, **kwargs)[source]
+class sympy.physics.quantum.grover.WGate(*args, **kwargs)[source]

General n qubit W Gate in Grover’s algorithm.

The gate performs the operation 2|phi><phi| - 1 on some qubits. |phi> = (tensor product of n Hadamards)*(|0> with n qubits)

@@ -875,7 +875,7 @@
Documentation Version
-sympy.physics.quantum.grover.apply_grover(oracle, nqubits, iterations=None)[source]
+sympy.physics.quantum.grover.apply_grover(oracle, nqubits, iterations=None)[source]

Applies grover’s algorithm.

Parameters:
@@ -906,7 +906,7 @@
Documentation Version
-sympy.physics.quantum.grover.grover_iteration(qstate, oracle)[source]
+sympy.physics.quantum.grover.grover_iteration(qstate, oracle)[source]

Applies one application of the Oracle and W Gate, WV.

Parameters:
@@ -942,7 +942,7 @@
Documentation Version
-sympy.physics.quantum.grover.superposition_basis(nqubits)[source]
+sympy.physics.quantum.grover.superposition_basis(nqubits)[source]

Creates an equal superposition of the computational basis.

Parameters:
diff --git a/dev/modules/physics/quantum/hilbert.html b/dev/modules/physics/quantum/hilbert.html index 7b0d5fb2a76..d7a6cae1fbc 100644 --- a/dev/modules/physics/quantum/hilbert.html +++ b/dev/modules/physics/quantum/hilbert.html @@ -809,7 +809,7 @@
Documentation Version
* Matt Curry

-class sympy.physics.quantum.hilbert.ComplexSpace(dimension)[source]
+class sympy.physics.quantum.hilbert.ComplexSpace(dimension)[source]

Finite dimensional Hilbert space of complex vectors.

The elements of this Hilbert space are n-dimensional complex valued vectors with the usual inner product that takes the complex conjugate @@ -840,7 +840,7 @@

Documentation Version
-class sympy.physics.quantum.hilbert.DirectSumHilbertSpace(*args)[source]
+class sympy.physics.quantum.hilbert.DirectSumHilbertSpace(*args)[source]

A direct sum of Hilbert spaces [R766].

This class uses the + operator to represent direct sums between different Hilbert spaces.

@@ -872,7 +872,7 @@
Documentation Version
-classmethod eval(args)[source]
+classmethod eval(args)[source]

Evaluates the direct product.

@@ -886,7 +886,7 @@
Documentation Version
-class sympy.physics.quantum.hilbert.FockSpace[source]
+class sympy.physics.quantum.hilbert.FockSpace[source]

The Hilbert space for second quantization.

Technically, this Hilbert space is a infinite direct sum of direct products of single particle Hilbert spaces [R767]. This is a mess, so we have @@ -912,7 +912,7 @@

Documentation Version
-class sympy.physics.quantum.hilbert.HilbertSpace[source]
+class sympy.physics.quantum.hilbert.HilbertSpace[source]

An abstract Hilbert space for quantum mechanics.

In short, a Hilbert space is an abstract vector space that is complete with inner products defined [R768].

@@ -941,7 +941,7 @@
Documentation Version
-class sympy.physics.quantum.hilbert.L2(interval)[source]
+class sympy.physics.quantum.hilbert.L2(interval)[source]

The Hilbert space of square integrable functions on an interval.

An L2 object takes in a single SymPy Interval argument which represents the interval its functions (vectors) are defined on.

@@ -961,7 +961,7 @@
Documentation Version
-class sympy.physics.quantum.hilbert.TensorPowerHilbertSpace(*args)[source]
+class sympy.physics.quantum.hilbert.TensorPowerHilbertSpace(*args)[source]

An exponentiated Hilbert space [R769].

Tensor powers (repeated tensor products) are represented by the operator ** Identical Hilbert spaces that are multiplied together @@ -1003,7 +1003,7 @@

Documentation Version
-class sympy.physics.quantum.hilbert.TensorProductHilbertSpace(*args)[source]
+class sympy.physics.quantum.hilbert.TensorProductHilbertSpace(*args)[source]

A tensor product of Hilbert spaces [R770].

The tensor product between Hilbert spaces is represented by the operator * Products of the same Hilbert space will be combined into @@ -1048,7 +1048,7 @@

Documentation Version
-classmethod eval(args)[source]
+classmethod eval(args)[source]

Evaluates the direct product.

diff --git a/dev/modules/physics/quantum/innerproduct.html b/dev/modules/physics/quantum/innerproduct.html index 0721cd6520f..80b29d39de4 100644 --- a/dev/modules/physics/quantum/innerproduct.html +++ b/dev/modules/physics/quantum/innerproduct.html @@ -806,7 +806,7 @@
Documentation Version

Symbolic inner product.

-class sympy.physics.quantum.innerproduct.InnerProduct(bra, ket)[source]
+class sympy.physics.quantum.innerproduct.InnerProduct(bra, ket)[source]

An unevaluated inner product between a Bra and a Ket [1].

Parameters:
diff --git a/dev/modules/physics/quantum/operator.html b/dev/modules/physics/quantum/operator.html index 7dc2efc8996..71ab4b0cccf 100644 --- a/dev/modules/physics/quantum/operator.html +++ b/dev/modules/physics/quantum/operator.html @@ -814,7 +814,7 @@
Documentation Version
-class sympy.physics.quantum.operator.DifferentialOperator(*args, **kwargs)[source]
+class sympy.physics.quantum.operator.DifferentialOperator(*args, **kwargs)[source]

An operator for representing the differential operator, i.e. d/dx

It is initialized by passing two arguments. The first is an arbitrary expression that involves a function, such as Derivative(f(x), x). The @@ -928,7 +928,7 @@

Documentation Version
-class sympy.physics.quantum.operator.HermitianOperator(*args, **kwargs)[source]
+class sympy.physics.quantum.operator.HermitianOperator(*args, **kwargs)[source]

A Hermitian operator that satisfies H == Dagger(H).

Parameters:
@@ -950,7 +950,7 @@
Documentation Version
-class sympy.physics.quantum.operator.IdentityOperator(*args, **kwargs)[source]
+class sympy.physics.quantum.operator.IdentityOperator(*args, **kwargs)[source]

An identity operator I that satisfies op * I == I * op == op for any operator op.

@@ -972,7 +972,7 @@
Documentation Version
-class sympy.physics.quantum.operator.Operator(*args, **kwargs)[source]
+class sympy.physics.quantum.operator.Operator(*args, **kwargs)[source]

Base class for non-commuting quantum operators.

An operator maps between quantum states [R772]. In quantum mechanics, observables (including, but not limited to, measured physical values) are @@ -1047,7 +1047,7 @@

Documentation Version
-class sympy.physics.quantum.operator.OuterProduct(*args, **old_assumptions)[source]
+class sympy.physics.quantum.operator.OuterProduct(*args, **old_assumptions)[source]

An unevaluated outer product between a ket and bra.

This constructs an outer product between any subclass of KetBase and BraBase as |a><b|. An OuterProduct inherits from Operator as they act as @@ -1127,7 +1127,7 @@

Documentation Version
-class sympy.physics.quantum.operator.UnitaryOperator(*args, **kwargs)[source]
+class sympy.physics.quantum.operator.UnitaryOperator(*args, **kwargs)[source]

A unitary operator that satisfies U*Dagger(U) == 1.

Parameters:
diff --git a/dev/modules/physics/quantum/operatorset.html b/dev/modules/physics/quantum/operatorset.html index 4149207d962..11554b13fef 100644 --- a/dev/modules/physics/quantum/operatorset.html +++ b/dev/modules/physics/quantum/operatorset.html @@ -816,7 +816,7 @@
Documentation Version
- Update the dictionary with a complete list of state-operator pairs

-sympy.physics.quantum.operatorset.operators_to_state(operators, **options)[source]
+sympy.physics.quantum.operatorset.operators_to_state(operators, **options)[source]

Returns the eigenstate of the given operator or set of operators

A global function for mapping operator classes to their associated states. It takes either an Operator or a set of operators and @@ -867,7 +867,7 @@

Documentation Version
-sympy.physics.quantum.operatorset.state_to_operators(state, **options)[source]
+sympy.physics.quantum.operatorset.state_to_operators(state, **options)[source]

Returns the operator or set of operators corresponding to the given eigenstate

A global function for mapping state classes to their associated diff --git a/dev/modules/physics/quantum/piab.html b/dev/modules/physics/quantum/piab.html index f4fdfdbba5b..31279acb335 100644 --- a/dev/modules/physics/quantum/piab.html +++ b/dev/modules/physics/quantum/piab.html @@ -806,19 +806,19 @@

Documentation Version

1D quantum particle in a box.

-class sympy.physics.quantum.piab.PIABBra(*args, **kwargs)[source]
+class sympy.physics.quantum.piab.PIABBra(*args, **kwargs)[source]

Particle in a box eigenbra.

-class sympy.physics.quantum.piab.PIABHamiltonian(*args, **kwargs)[source]
+class sympy.physics.quantum.piab.PIABHamiltonian(*args, **kwargs)[source]

Particle in a box Hamiltonian operator.

-class sympy.physics.quantum.piab.PIABKet(*args, **kwargs)[source]
+class sympy.physics.quantum.piab.PIABKet(*args, **kwargs)[source]

Particle in a box eigenket.

diff --git a/dev/modules/physics/quantum/qapply.html b/dev/modules/physics/quantum/qapply.html index 629d943cbd5..b628ffe9bb1 100644 --- a/dev/modules/physics/quantum/qapply.html +++ b/dev/modules/physics/quantum/qapply.html @@ -808,7 +808,7 @@
Documentation Version
* Sometimes the final result needs to be expanded, we should do this by hand.

-sympy.physics.quantum.qapply.qapply(e, **options)[source]
+sympy.physics.quantum.qapply.qapply(e, **options)[source]

Apply operators to states in a quantum expression.

Parameters:
diff --git a/dev/modules/physics/quantum/qft.html b/dev/modules/physics/quantum/qft.html index 0f4e28c4093..d15cbf03b53 100644 --- a/dev/modules/physics/quantum/qft.html +++ b/dev/modules/physics/quantum/qft.html @@ -816,11 +816,11 @@
Documentation Version
-class sympy.physics.quantum.qft.IQFT(*args, **kwargs)[source]
+class sympy.physics.quantum.qft.IQFT(*args, **kwargs)[source]

The inverse quantum Fourier transform.

-decompose()[source]
+decompose()[source]

Decomposes IQFT into elementary gates.

@@ -828,11 +828,11 @@
Documentation Version
-class sympy.physics.quantum.qft.QFT(*args, **kwargs)[source]
+class sympy.physics.quantum.qft.QFT(*args, **kwargs)[source]

The forward quantum Fourier transform.

-decompose()[source]
+decompose()[source]

Decomposes QFT into elementary gates.

@@ -840,13 +840,13 @@
Documentation Version
-sympy.physics.quantum.qft.Rk[source]
+sympy.physics.quantum.qft.Rk[source]

alias of RkGate

-class sympy.physics.quantum.qft.RkGate(*args)[source]
+class sympy.physics.quantum.qft.RkGate(*args)[source]

This is the R_k gate of the QTF.

diff --git a/dev/modules/physics/quantum/qubit.html b/dev/modules/physics/quantum/qubit.html index 76ccaa179c8..1a6ea7b03ed 100644 --- a/dev/modules/physics/quantum/qubit.html +++ b/dev/modules/physics/quantum/qubit.html @@ -810,7 +810,7 @@
Documentation Version
* Update tests.

-class sympy.physics.quantum.qubit.IntQubit(*args, **kwargs)[source]
+class sympy.physics.quantum.qubit.IntQubit(*args, **kwargs)[source]

A qubit ket that store integers as binary numbers in qubit values.

The differences between this class and Qubit are:

    @@ -885,13 +885,13 @@
    Documentation Version
    -class sympy.physics.quantum.qubit.IntQubitBra(*args, **kwargs)[source]
    +class sympy.physics.quantum.qubit.IntQubitBra(*args, **kwargs)[source]

    A qubit bra that store integers as binary numbers in qubit values.

    -class sympy.physics.quantum.qubit.Qubit(*args, **kwargs)[source]
    +class sympy.physics.quantum.qubit.Qubit(*args, **kwargs)[source]

    A multi-qubit ket in the computational (z) basis.

    We use the normal convention that the least significant qubit is on the right, so |00001> has a 1 in the least significant qubit.

    @@ -948,7 +948,7 @@
    Documentation Version
    -class sympy.physics.quantum.qubit.QubitBra(*args, **kwargs)[source]
    +class sympy.physics.quantum.qubit.QubitBra(*args, **kwargs)[source]

    A multi-qubit bra in the computational (z) basis.

    We use the normal convention that the least significant qubit is on the right, so |00001> has a 1 in the least significant qubit.

    @@ -971,7 +971,7 @@
    Documentation Version
    -sympy.physics.quantum.qubit.matrix_to_density(mat)[source]
    +sympy.physics.quantum.qubit.matrix_to_density(mat)[source]

    Works by finding the eigenvectors and eigenvalues of the matrix. We know we can decompose rho by doing: sum(EigenVal*|Eigenvect><Eigenvect|)

    @@ -979,7 +979,7 @@
    Documentation Version
    -sympy.physics.quantum.qubit.matrix_to_qubit(matrix)[source]
    +sympy.physics.quantum.qubit.matrix_to_qubit(matrix)[source]

    Convert from the matrix repr. to a sum of Qubit objects.

    Parameters:
    @@ -1003,7 +1003,7 @@
    Documentation Version
    -sympy.physics.quantum.qubit.measure_all(qubit, format='sympy', normalize=True)[source]
    +sympy.physics.quantum.qubit.measure_all(qubit, format='sympy', normalize=True)[source]

    Perform an ensemble measurement of all qubits.

    Parameters:
    @@ -1044,7 +1044,7 @@
    Documentation Version
    -sympy.physics.quantum.qubit.measure_all_oneshot(qubit, format='sympy')[source]
    +sympy.physics.quantum.qubit.measure_all_oneshot(qubit, format='sympy')[source]

    Perform a oneshot ensemble measurement on all qubits.

    A oneshot measurement is equivalent to performing a measurement on a quantum system. This type of measurement does not return the probabilities @@ -1085,7 +1085,7 @@

    Documentation Version
    normalize=True,
    -)[source] +)[source]

    Perform a partial ensemble measure on the specified qubits.

    Parameters:
    @@ -1138,7 +1138,7 @@
    Documentation Version
    format='sympy',
    -)[source] +)[source]

    Perform a partial oneshot measurement on the specified qubits.

    A oneshot measurement is equivalent to performing a measurement on a quantum system. This type of measurement does not return the probabilities @@ -1174,7 +1174,7 @@

    Documentation Version
    -sympy.physics.quantum.qubit.qubit_to_matrix(qubit, format='sympy')[source]
    +sympy.physics.quantum.qubit.qubit_to_matrix(qubit, format='sympy')[source]

    Converts an Add/Mul of Qubit objects into it’s matrix representation

    This function is the inverse of matrix_to_qubit and is a shorthand for represent(qubit).

    diff --git a/dev/modules/physics/quantum/represent.html b/dev/modules/physics/quantum/represent.html index 6bf5732dd0a..28eb9917ba8 100644 --- a/dev/modules/physics/quantum/represent.html +++ b/dev/modules/physics/quantum/represent.html @@ -811,7 +811,7 @@
    Documentation Version
-sympy.physics.quantum.represent.enumerate_states(*args, **options)[source]
+sympy.physics.quantum.represent.enumerate_states(*args, **options)[source]

Returns instances of the given state with dummy indices appended

Operates in two different modes:

    @@ -855,7 +855,7 @@
    Documentation Version
    **options,
-)[source] +)[source]

Returns a basis state instance corresponding to the basis specified in options=s. If no basis is specified, the function tries to form a default basis state of the given expression.

@@ -902,7 +902,7 @@
Documentation Version
-sympy.physics.quantum.represent.integrate_result(orig_expr, result, **options)[source]
+sympy.physics.quantum.represent.integrate_result(orig_expr, result, **options)[source]

Returns the result of integrating over any unities (|x><x|) in the given expression. Intended for integrating over the result of representations in continuous bases.

@@ -944,7 +944,7 @@
Documentation Version
-sympy.physics.quantum.represent.rep_expectation(expr, **options)[source]
+sympy.physics.quantum.represent.rep_expectation(expr, **options)[source]

Returns an <x'|A|x> type representation for the given operator.

Parameters:
@@ -969,7 +969,7 @@
Documentation Version
-sympy.physics.quantum.represent.rep_innerproduct(expr, **options)[source]
+sympy.physics.quantum.represent.rep_innerproduct(expr, **options)[source]

Returns an innerproduct like representation (e.g. <x'|x>) for the given state.

Attempts to calculate inner product with a bra from the specified @@ -997,7 +997,7 @@

Documentation Version
-sympy.physics.quantum.represent.represent(expr, **options)[source]
+sympy.physics.quantum.represent.represent(expr, **options)[source]

Represent the quantum expression in the given basis.

In quantum mechanics abstract states and operators can be represented in various basis sets. Under this operation the follow transforms happen:

diff --git a/dev/modules/physics/quantum/shor.html b/dev/modules/physics/quantum/shor.html index 4d8b6de811f..b6abb141d48 100644 --- a/dev/modules/physics/quantum/shor.html +++ b/dev/modules/physics/quantum/shor.html @@ -812,7 +812,7 @@
Documentation Version
-class sympy.physics.quantum.shor.CMod(*args, **kwargs)[source]
+class sympy.physics.quantum.shor.CMod(*args, **kwargs)[source]

A controlled mod gate.

This is black box controlled Mod function for use by shor’s algorithm. TODO: implement a decompose property that returns how to do this in terms @@ -839,7 +839,7 @@

Documentation Version
-sympy.physics.quantum.shor.period_find(a, N)[source]
+sympy.physics.quantum.shor.period_find(a, N)[source]

Finds the period of a in modulo N arithmetic

This is quantum part of Shor’s algorithm. It takes two registers, puts first in superposition of states with Hadamards so: |k>|0> @@ -849,7 +849,7 @@

Documentation Version
-sympy.physics.quantum.shor.shor(N)[source]
+sympy.physics.quantum.shor.shor(N)[source]

This function implements Shor’s factoring algorithm on the Integer N

The algorithm starts by picking a random number (a) and seeing if it is coprime with N. If it is not, then the gcd of the two numbers is a factor diff --git a/dev/modules/physics/quantum/spin.html b/dev/modules/physics/quantum/spin.html index 345c2770ca4..f8d8c58254d 100644 --- a/dev/modules/physics/quantum/spin.html +++ b/dev/modules/physics/quantum/spin.html @@ -806,13 +806,13 @@

Documentation Version

Quantum mechanical angular momemtum.

-class sympy.physics.quantum.spin.J2Op(*args, **kwargs)[source]
+class sympy.physics.quantum.spin.J2Op(*args, **kwargs)[source]

The J^2 operator.

-class sympy.physics.quantum.spin.JxBra(j, m)[source]
+class sympy.physics.quantum.spin.JxBra(j, m)[source]

Eigenbra of Jx.

See JzKet for the usage of spin eigenstates.

@@ -826,7 +826,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JxBraCoupled(j, m, jn, *jcoupling)[source]
+class sympy.physics.quantum.spin.JxBraCoupled(j, m, jn, *jcoupling)[source]

Coupled eigenbra of Jx.

See JzKetCoupled for the usage of coupled spin eigenstates.

@@ -840,7 +840,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JxKet(j, m)[source]
+class sympy.physics.quantum.spin.JxKet(j, m)[source]

Eigenket of Jx.

See JzKet for the usage of spin eigenstates.

@@ -854,7 +854,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JxKetCoupled(j, m, jn, *jcoupling)[source]
+class sympy.physics.quantum.spin.JxKetCoupled(j, m, jn, *jcoupling)[source]

Coupled eigenket of Jx.

See JzKetCoupled for the usage of coupled spin eigenstates.

@@ -868,7 +868,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JyBra(j, m)[source]
+class sympy.physics.quantum.spin.JyBra(j, m)[source]

Eigenbra of Jy.

See JzKet for the usage of spin eigenstates.

@@ -882,7 +882,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JyBraCoupled(j, m, jn, *jcoupling)[source]
+class sympy.physics.quantum.spin.JyBraCoupled(j, m, jn, *jcoupling)[source]

Coupled eigenbra of Jy.

See JzKetCoupled for the usage of coupled spin eigenstates.

@@ -896,7 +896,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JyKet(j, m)[source]
+class sympy.physics.quantum.spin.JyKet(j, m)[source]

Eigenket of Jy.

See JzKet for the usage of spin eigenstates.

@@ -910,7 +910,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JyKetCoupled(j, m, jn, *jcoupling)[source]
+class sympy.physics.quantum.spin.JyKetCoupled(j, m, jn, *jcoupling)[source]

Coupled eigenket of Jy.

See JzKetCoupled for the usage of coupled spin eigenstates.

@@ -924,7 +924,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JzBra(j, m)[source]
+class sympy.physics.quantum.spin.JzBra(j, m)[source]

Eigenbra of Jz.

See the JzKet for the usage of spin eigenstates.

@@ -938,7 +938,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JzBraCoupled(j, m, jn, *jcoupling)[source]
+class sympy.physics.quantum.spin.JzBraCoupled(j, m, jn, *jcoupling)[source]

Coupled eigenbra of Jz.

See the JzKetCoupled for the usage of coupled spin eigenstates.

@@ -952,7 +952,7 @@
Documentation Version
-class sympy.physics.quantum.spin.JzKet(j, m)[source]
+class sympy.physics.quantum.spin.JzKet(j, m)[source]

Eigenket of Jz.

Spin state which is an eigenstate of the Jz operator. Uncoupled states, that is states representing the interaction of multiple separate spin @@ -1068,7 +1068,7 @@

Documentation Version
-class sympy.physics.quantum.spin.JzKetCoupled(j, m, jn, *jcoupling)[source]
+class sympy.physics.quantum.spin.JzKetCoupled(j, m, jn, *jcoupling)[source]

Coupled eigenket of Jz

Spin state that is an eigenket of Jz which represents the coupling of separate spin spaces.

@@ -1186,13 +1186,13 @@
Documentation Version
-class sympy.physics.quantum.spin.JzOp(*args, **kwargs)[source]
+class sympy.physics.quantum.spin.JzOp(*args, **kwargs)[source]

The Jz operator.

-class sympy.physics.quantum.spin.Rotation(*args, **kwargs)[source]
+class sympy.physics.quantum.spin.Rotation(*args, **kwargs)[source]

Wigner D operator in terms of Euler angles.

Defines the rotation operator in terms of the Euler angles defined by the z-y-z convention for a passive transformation. That is the coordinate @@ -1254,7 +1254,7 @@

Documentation Version
-classmethod D(j, m, mp, alpha, beta, gamma)[source]
+classmethod D(j, m, mp, alpha, beta, gamma)[source]

Wigner D-function.

Returns an instance of the WignerD class corresponding to the Wigner-D function specified by the parameters.

@@ -1307,7 +1307,7 @@
Documentation Version
-classmethod d(j, m, mp, beta)[source]
+classmethod d(j, m, mp, beta)[source]

Wigner small-d function.

Returns an instance of the WignerD class corresponding to the Wigner-D function specified by the parameters with the alpha and gamma angles @@ -1355,7 +1355,7 @@

Documentation Version
-class sympy.physics.quantum.spin.WignerD(*args, **hints)[source]
+class sympy.physics.quantum.spin.WignerD(*args, **hints)[source]

Wigner-D function

The Wigner D-function gives the matrix elements of the rotation operator in the jm-representation. For the Euler angles \(\alpha\), @@ -1448,7 +1448,7 @@

Documentation Version
-sympy.physics.quantum.spin.couple(expr, jcoupling_list=None)[source]
+sympy.physics.quantum.spin.couple(expr, jcoupling_list=None)[source]

Couple a tensor product of spin states

This function can be used to couple an uncoupled tensor product of spin states. All of the eigenstates to be coupled must be of the same class. It @@ -1507,7 +1507,7 @@

Documentation Version
-sympy.physics.quantum.spin.uncouple(expr, jn=None, jcoupling_list=None)[source]
+sympy.physics.quantum.spin.uncouple(expr, jn=None, jcoupling_list=None)[source]

Uncouple a coupled spin state

Gives the uncoupled representation of a coupled spin state. Arguments must be either a spin state that is a subclass of CoupledSpinState or a spin diff --git a/dev/modules/physics/quantum/state.html b/dev/modules/physics/quantum/state.html index 2903cf34be3..b1f14771b1f 100644 --- a/dev/modules/physics/quantum/state.html +++ b/dev/modules/physics/quantum/state.html @@ -806,7 +806,7 @@

Documentation Version

Dirac notation for states.

-class sympy.physics.quantum.state.Bra(*args, **kwargs)[source]
+class sympy.physics.quantum.state.Bra(*args, **kwargs)[source]

A general time-independent Bra in quantum mechanics.

Inherits from State and BraBase. A Bra is the dual of a Ket [R777]. This class and its subclasses will be the main classes that users will use for @@ -866,7 +866,7 @@

Documentation Version
-class sympy.physics.quantum.state.BraBase(*args, **kwargs)[source]
+class sympy.physics.quantum.state.BraBase(*args, **kwargs)[source]

Base class for Bras.

This class defines the dual property and the brackets for printing. This is an abstract base class and you should not instantiate it directly, @@ -875,7 +875,7 @@

Documentation Version
-class sympy.physics.quantum.state.Ket(*args, **kwargs)[source]
+class sympy.physics.quantum.state.Ket(*args, **kwargs)[source]

A general time-independent Ket in quantum mechanics.

Inherits from State and KetBase. This class should be used as the base class for all physical, time-independent Kets in a system. This class @@ -939,7 +939,7 @@

Documentation Version
-class sympy.physics.quantum.state.KetBase(*args, **kwargs)[source]
+class sympy.physics.quantum.state.KetBase(*args, **kwargs)[source]

Base class for Kets.

This class defines the dual property and the brackets for printing. This is an abstract base class and you should not instantiate it directly, instead @@ -948,13 +948,13 @@

Documentation Version
-class sympy.physics.quantum.state.OrthogonalBra(*args, **kwargs)[source]
+class sympy.physics.quantum.state.OrthogonalBra(*args, **kwargs)[source]

Orthogonal Bra in quantum mechanics.

-class sympy.physics.quantum.state.OrthogonalKet(*args, **kwargs)[source]
+class sympy.physics.quantum.state.OrthogonalKet(*args, **kwargs)[source]

Orthogonal Ket in quantum mechanics.

The inner product of two states with different labels will give zero, states with the same label will give one.

@@ -972,19 +972,19 @@
Documentation Version
-class sympy.physics.quantum.state.OrthogonalState(*args, **kwargs)[source]
+class sympy.physics.quantum.state.OrthogonalState(*args, **kwargs)[source]

General abstract quantum state used as a base class for Ket and Bra.

-class sympy.physics.quantum.state.State(*args, **kwargs)[source]
+class sympy.physics.quantum.state.State(*args, **kwargs)[source]

General abstract quantum state used as a base class for Ket and Bra.

-class sympy.physics.quantum.state.StateBase(*args, **kwargs)[source]
+class sympy.physics.quantum.state.StateBase(*args, **kwargs)[source]

Abstract base class for general abstract states in quantum mechanics.

All other state classes defined will need to inherit from this class. It carries the basic structure for all other states such as dual, _eval_adjoint @@ -999,7 +999,7 @@

Documentation Version
-classmethod dual_class()[source]
+classmethod dual_class()[source]

Return the class used to construct the dual.

@@ -1013,7 +1013,7 @@
Documentation Version
-class sympy.physics.quantum.state.TimeDepBra(*args, **kwargs)[source]
+class sympy.physics.quantum.state.TimeDepBra(*args, **kwargs)[source]

General time-dependent Bra in quantum mechanics.

This inherits from TimeDepState and BraBase and is the main class that should be used for Bras that vary with time. Its dual is a TimeDepBra.

@@ -1046,7 +1046,7 @@
Documentation Version
-class sympy.physics.quantum.state.TimeDepKet(*args, **kwargs)[source]
+class sympy.physics.quantum.state.TimeDepKet(*args, **kwargs)[source]

General time-dependent Ket in quantum mechanics.

This inherits from TimeDepState and KetBase and is the main class that should be used for Kets that vary with time. Its dual is a @@ -1086,7 +1086,7 @@

Documentation Version
-class sympy.physics.quantum.state.TimeDepState(*args, **kwargs)[source]
+class sympy.physics.quantum.state.TimeDepState(*args, **kwargs)[source]

Base class for a general time-dependent quantum state.

This class is used as a base class for any time-dependent state. The main difference between this class and the time-independent state is that this @@ -1118,7 +1118,7 @@

Documentation Version
-class sympy.physics.quantum.state.Wavefunction(*args)[source]
+class sympy.physics.quantum.state.Wavefunction(*args)[source]

Class for representations in continuous bases

This class takes an expression and coordinates in its constructor. It can be used to easily calculate normalizations and probabilities.

@@ -1288,7 +1288,7 @@
Documentation Version
-normalize()[source]
+normalize()[source]

Return a normalized version of the Wavefunction

Examples

>>> from sympy import symbols, pi
@@ -1307,7 +1307,7 @@ 
Documentation Version
-prob()[source]
+prob()[source]

Return the absolute magnitude of the w.f., \(|\psi(x)|^2\)

Examples

>>> from sympy import symbols, pi
diff --git a/dev/modules/physics/quantum/tensorproduct.html b/dev/modules/physics/quantum/tensorproduct.html
index dd069a07d18..243e32feefe 100644
--- a/dev/modules/physics/quantum/tensorproduct.html
+++ b/dev/modules/physics/quantum/tensorproduct.html
@@ -806,7 +806,7 @@ 
Documentation Version

Abstract tensor product.

-class sympy.physics.quantum.tensorproduct.TensorProduct(*args)[source]
+class sympy.physics.quantum.tensorproduct.TensorProduct(*args)[source]

The tensor product of two or more arguments.

For matrices, this uses matrix_tensor_product to compute the Kronecker or tensor product matrix. For other objects a symbolic TensorProduct @@ -875,7 +875,7 @@

Documentation Version
-sympy.physics.quantum.tensorproduct.tensor_product_simp(e, **hints)[source]
+sympy.physics.quantum.tensorproduct.tensor_product_simp(e, **hints)[source]

Try to simplify and combine TensorProducts.

In general this will try to pull expressions inside of TensorProducts. It currently only works for relatively simple cases where the products have diff --git a/dev/modules/physics/secondquant.html b/dev/modules/physics/secondquant.html index fc182ea05cb..a595f3afdc2 100644 --- a/dev/modules/physics/secondquant.html +++ b/dev/modules/physics/secondquant.html @@ -808,7 +808,7 @@

Documentation Version
of Many-Particle Systems.”

-class sympy.physics.secondquant.AnnihilateBoson(k)[source]
+class sympy.physics.secondquant.AnnihilateBoson(k)[source]

Bosonic annihilation operator.

Examples

>>> from sympy.physics.secondquant import B
@@ -819,7 +819,7 @@ 
Documentation Version
-apply_operator(state)[source]
+apply_operator(state)[source]

Apply state to self if self is not symbolic and state is a FockStateKet, else multiply self by state.

Examples

@@ -837,11 +837,11 @@
Documentation Version
-class sympy.physics.secondquant.AnnihilateFermion(k)[source]
+class sympy.physics.secondquant.AnnihilateFermion(k)[source]

Fermionic annihilation operator.

-apply_operator(state)[source]
+apply_operator(state)[source]

Apply state to self if self is not symbolic and state is a FockStateKet, else multiply self by state.

Examples

@@ -949,7 +949,7 @@
Documentation Version
-class sympy.physics.secondquant.AntiSymmetricTensor(symbol, upper, lower)[source]
+class sympy.physics.secondquant.AntiSymmetricTensor(symbol, upper, lower)[source]

Stores upper and lower indices in separate Tuple’s.

Each group of indices is assumed to be antisymmetric.

Examples

@@ -1019,37 +1019,37 @@
Documentation Version
-sympy.physics.secondquant.B[source]
+sympy.physics.secondquant.B[source]

alias of AnnihilateBoson

-sympy.physics.secondquant.BBra[source]
+sympy.physics.secondquant.BBra[source]

alias of FockStateBosonBra

-sympy.physics.secondquant.BKet[source]
+sympy.physics.secondquant.BKet[source]

alias of FockStateBosonKet

-sympy.physics.secondquant.Bd[source]
+sympy.physics.secondquant.Bd[source]

alias of CreateBoson

-class sympy.physics.secondquant.BosonicBasis[source]
+class sympy.physics.secondquant.BosonicBasis[source]

Base class for a basis set of bosonic Fock states.

-class sympy.physics.secondquant.Commutator(a, b)[source]
+class sympy.physics.secondquant.Commutator(a, b)[source]

The Commutator: [A, B] = A*B - B*A

The arguments are ordered according to .__cmp__()

Examples

@@ -1090,7 +1090,7 @@
Documentation Version
-doit(**hints)[source]
+doit(**hints)[source]

Enables the computation of complex expressions.

Examples

>>> from sympy.physics.secondquant import Commutator, F, Fd
@@ -1106,7 +1106,7 @@ 
Documentation Version
-classmethod eval(a, b)[source]
+classmethod eval(a, b)[source]

The Commutator [A,B] is on canonical form if A < B.

Examples

>>> from sympy.physics.secondquant import Commutator, F, Fd
@@ -1123,11 +1123,11 @@ 
Documentation Version
-class sympy.physics.secondquant.CreateBoson(k)[source]
+class sympy.physics.secondquant.CreateBoson(k)[source]

Bosonic creation operator.

-apply_operator(state)[source]
+apply_operator(state)[source]

Apply state to self if self is not symbolic and state is a FockStateKet, else multiply self by state.

Examples

@@ -1145,11 +1145,11 @@
Documentation Version
-class sympy.physics.secondquant.CreateFermion(k)[source]
+class sympy.physics.secondquant.CreateFermion(k)[source]

Fermionic creation operator.

-apply_operator(state)[source]
+apply_operator(state)[source]

Apply state to self if self is not symbolic and state is a FockStateKet, else multiply self by state.

Examples

@@ -1257,7 +1257,7 @@
Documentation Version
-class sympy.physics.secondquant.Dagger(arg)[source]
+class sympy.physics.secondquant.Dagger(arg)[source]

Hermitian conjugate of creation/annihilation operators.

Examples

>>> from sympy import I
@@ -1272,7 +1272,7 @@ 
Documentation Version
-classmethod eval(arg)[source]
+classmethod eval(arg)[source]

Evaluates the Dagger instance.

Examples

>>> from sympy import I
@@ -1292,31 +1292,31 @@ 
Documentation Version
-sympy.physics.secondquant.F[source]
+sympy.physics.secondquant.F[source]

alias of AnnihilateFermion

-sympy.physics.secondquant.FBra[source]
+sympy.physics.secondquant.FBra[source]

alias of FockStateFermionBra

-sympy.physics.secondquant.FKet[source]
+sympy.physics.secondquant.FKet[source]

alias of FockStateFermionKet

-sympy.physics.secondquant.Fd[source]
+sympy.physics.secondquant.Fd[source]

alias of CreateFermion

-class sympy.physics.secondquant.FixedBosonicBasis(n_particles, n_levels)[source]
+class sympy.physics.secondquant.FixedBosonicBasis(n_particles, n_levels)[source]

Fixed particle number basis set.

Examples

>>> from sympy.physics.secondquant import FixedBosonicBasis
@@ -1332,7 +1332,7 @@ 
Documentation Version
-index(state)[source]
+index(state)[source]

Returns the index of state in basis.

Examples

>>> from sympy.physics.secondquant import FixedBosonicBasis
@@ -1345,7 +1345,7 @@ 
Documentation Version
-state(i)[source]
+state(i)[source]

Returns the state that lies at index i of the basis

Examples

>>> from sympy.physics.secondquant import FixedBosonicBasis
@@ -1360,7 +1360,7 @@ 
Documentation Version
-class sympy.physics.secondquant.FockState(occupations)[source]
+class sympy.physics.secondquant.FockState(occupations)[source]

Many particle Fock state with a sequence of occupation numbers.

Anywhere you can have a FockState, you can also have S.Zero. All code must check for this!

@@ -1369,7 +1369,7 @@
Documentation Version
-class sympy.physics.secondquant.FockStateBosonBra(occupations)[source]
+class sympy.physics.secondquant.FockStateBosonBra(occupations)[source]

Describes a collection of BosonBra particles.

Examples

>>> from sympy.physics.secondquant import BBra
@@ -1381,7 +1381,7 @@ 
Documentation Version
-class sympy.physics.secondquant.FockStateBosonKet(occupations)[source]
+class sympy.physics.secondquant.FockStateBosonKet(occupations)[source]

Many particle Fock state with a sequence of occupation numbers.

Occupation numbers can be any integer >= 0.

Examples

@@ -1394,13 +1394,13 @@
Documentation Version
-class sympy.physics.secondquant.FockStateBra(occupations)[source]
+class sympy.physics.secondquant.FockStateBra(occupations)[source]

Representation of a bra.

-class sympy.physics.secondquant.FockStateFermionBra(occupations, fermi_level=0)[source]
+class sympy.physics.secondquant.FockStateFermionBra(occupations, fermi_level=0)[source]

Examples

>>> from sympy.physics.secondquant import FBra
 >>> FBra([1, 2])
@@ -1415,7 +1415,7 @@ 
Documentation Version
-class sympy.physics.secondquant.FockStateFermionKet(occupations, fermi_level=0)[source]
+class sympy.physics.secondquant.FockStateFermionKet(occupations, fermi_level=0)[source]

Many-particle Fock state with a sequence of occupied orbits.

Explanation

Each state can only have one particle, so we choose to store a list of @@ -1434,13 +1434,13 @@

Documentation Version
-class sympy.physics.secondquant.FockStateKet(occupations)[source]
+class sympy.physics.secondquant.FockStateKet(occupations)[source]

Representation of a ket.

-class sympy.physics.secondquant.InnerProduct(bra, ket)[source]
+class sympy.physics.secondquant.InnerProduct(bra, ket)[source]

An unevaluated inner product between a bra and ket.

Explanation

Currently this class just reduces things to a product of @@ -1463,7 +1463,7 @@

Documentation Version
-class sympy.physics.secondquant.KroneckerDelta(i, j, delta_range=None)[source]
+class sympy.physics.secondquant.KroneckerDelta(i, j, delta_range=None)[source]

The discrete, or Kronecker, delta function.

Parameters:
@@ -1514,7 +1514,7 @@
Documentation Version
-classmethod eval(i, j, delta_range=None)[source]
+classmethod eval(i, j, delta_range=None)[source]

Evaluates the discrete delta function.

Examples

>>> from sympy import KroneckerDelta
@@ -1711,7 +1711,7 @@ 
Documentation Version
-class sympy.physics.secondquant.NO(arg)[source]
+class sympy.physics.secondquant.NO(arg)[source]

This Object is used to represent normal ordering brackets.

i.e. {abcd} sometimes written :abcd:

Explanation

@@ -1736,7 +1736,7 @@
Documentation Version
Nothing more, nothing less.

-doit(**hints)[source]
+doit(**hints)[source]

Either removes the brackets or enables complex computations in its arguments.

Examples

@@ -1757,7 +1757,7 @@
Documentation Version
-get_subNO(i)[source]
+get_subNO(i)[source]

Returns a NO() without FermionicOperator at index i.

Examples

>>> from sympy import symbols
@@ -1817,7 +1817,7 @@ 
Documentation Version
-iter_q_annihilators()[source]
+iter_q_annihilators()[source]

Iterates over the annihilation operators.

Examples

>>> from sympy import symbols
@@ -1839,7 +1839,7 @@ 
Documentation Version
-iter_q_creators()[source]
+iter_q_creators()[source]

Iterates over the creation operators.

Examples

>>> from sympy import symbols
@@ -1863,12 +1863,12 @@ 
Documentation Version
-class sympy.physics.secondquant.PermutationOperator(i, j)[source]
+class sympy.physics.secondquant.PermutationOperator(i, j)[source]

Represents the index permutation operator P(ij).

P(ij)*f(i)*g(j) = f(i)*g(j) - f(j)*g(i)

-get_permuted(expr)[source]
+get_permuted(expr)[source]

Returns -expr with permuted indices.

Explanation

>>> from sympy import symbols, Function
@@ -1885,7 +1885,7 @@ 
Documentation Version
-class sympy.physics.secondquant.VarBosonicBasis(n_max)[source]
+class sympy.physics.secondquant.VarBosonicBasis(n_max)[source]

A single state, variable particle number basis set.

Examples

>>> from sympy.physics.secondquant import VarBosonicBasis
@@ -1897,7 +1897,7 @@ 
Documentation Version
-index(state)[source]
+index(state)[source]

Returns the index of state in basis.

Examples

>>> from sympy.physics.secondquant import VarBosonicBasis
@@ -1915,7 +1915,7 @@ 
Documentation Version
-state(i)[source]
+state(i)[source]

The state of a single basis.

Examples

>>> from sympy.physics.secondquant import VarBosonicBasis
@@ -1930,7 +1930,7 @@ 
Documentation Version
-sympy.physics.secondquant.apply_operators(e)[source]
+sympy.physics.secondquant.apply_operators(e)[source]

Take a SymPy expression with operators and states and apply the operators.

Examples

>>> from sympy.physics.secondquant import apply_operators
@@ -1943,7 +1943,7 @@ 
Documentation Version
-sympy.physics.secondquant.contraction(a, b)[source]
+sympy.physics.secondquant.contraction(a, b)[source]

Calculates contraction of Fermionic operators a and b.

Examples

>>> from sympy import symbols
@@ -1980,7 +1980,7 @@ 
Documentation Version
-sympy.physics.secondquant.evaluate_deltas(e)[source]
+sympy.physics.secondquant.evaluate_deltas(e)[source]

We evaluate KroneckerDelta symbols in the expression assuming Einstein summation.

Explanation

If one index is repeated it is summed over and in effect substituted with @@ -2040,7 +2040,7 @@

Documentation Version
-sympy.physics.secondquant.matrix_rep(op, basis)[source]
+sympy.physics.secondquant.matrix_rep(op, basis)[source]

Find the representation of an operator in a basis.

Examples

>>> from sympy.physics.secondquant import VarBosonicBasis, B, matrix_rep
@@ -2066,7 +2066,7 @@ 
Documentation Version
permutation_operators,
-)[source] +)[source]

Performs simplification by introducing PermutationOperators where appropriate.

Explanation

@@ -2109,7 +2109,7 @@
Documentation Version
pretty_indices={},
-)[source] +)[source]

Collect terms by substitution of dummy variables.

Explanation

This routine allows simplification of Add expressions containing terms @@ -2168,7 +2168,7 @@

Documentation Version
-sympy.physics.secondquant.wicks(e, **kw_args)[source]
+sympy.physics.secondquant.wicks(e, **kw_args)[source]

Returns the normal ordered equivalent of an expression using Wicks Theorem.

Examples

>>> from sympy import symbols, Dummy
diff --git a/dev/modules/physics/sho.html b/dev/modules/physics/sho.html
index 7a892120e5e..8682a4ea8ee 100644
--- a/dev/modules/physics/sho.html
+++ b/dev/modules/physics/sho.html
@@ -805,7 +805,7 @@ 
Documentation Version

Quantum Harmonic Oscillator in 3-D

-sympy.physics.sho.E_nl(n, l, hw)[source]
+sympy.physics.sho.E_nl(n, l, hw)[source]

Returns the Energy of an isotropic harmonic oscillator.

Parameters:
@@ -841,7 +841,7 @@
Documentation Version
-sympy.physics.sho.R_nl(n, l, nu, r)[source]
+sympy.physics.sho.R_nl(n, l, nu, r)[source]

Returns the radial wavefunction R_{nl} for a 3d isotropic harmonic oscillator.

diff --git a/dev/modules/physics/units/dimensions.html b/dev/modules/physics/units/dimensions.html index 1b40b8ad88e..45c49030753 100644 --- a/dev/modules/physics/units/dimensions.html +++ b/dev/modules/physics/units/dimensions.html @@ -812,7 +812,7 @@
Documentation Version
question of adding time to length has no meaning.

-class sympy.physics.units.dimensions.Dimension(name, symbol=None)[source]
+class sympy.physics.units.dimensions.Dimension(name, symbol=None)[source]

This class represent the dimension of a physical quantities.

The Dimension constructor takes as parameters a name and an optional symbol.

@@ -853,7 +853,7 @@
Documentation Version
-has_integer_powers(dim_sys)[source]
+has_integer_powers(dim_sys)[source]

Check if the dimension object has only integer powers.

All the dimension powers should be integers, but rational powers may appear in intermediate steps. This method may be used to check that the @@ -872,7 +872,7 @@

Documentation Version
dimensional_dependencies={},
-)[source] +)[source]

DimensionSystem represents a coherent set of dimensions.

The constructor takes three parameters:

    @@ -905,7 +905,7 @@
    Documentation Version
    -dim_can_vector(dim)[source]
    +dim_can_vector(dim)[source]

    Useless method, kept for compatibility with previous versions.

    DO NOT USE.

    Dimensional representation in terms of the canonical base dimensions.

    @@ -913,7 +913,7 @@
    Documentation Version
    -dim_vector(dim)[source]
    +dim_vector(dim)[source]

    Useless method, kept for compatibility with previous versions.

    DO NOT USE.

    Vector representation in terms of the base dimensions.

    @@ -944,7 +944,7 @@
    Documentation Version
    -is_dimensionless(dimension)[source]
    +is_dimensionless(dimension)[source]

    Check if the dimension object really has a dimension.

    A dimension should have at least one component with non-zero power.

    @@ -959,7 +959,7 @@
    Documentation Version
    -print_dim_base(dim)[source]
    +print_dim_base(dim)[source]

    Give the string expression of a dimension in term of the basis symbols.

    diff --git a/dev/modules/physics/units/prefixes.html b/dev/modules/physics/units/prefixes.html index 64a5cfc2992..eb42926c5dd 100644 --- a/dev/modules/physics/units/prefixes.html +++ b/dev/modules/physics/units/prefixes.html @@ -818,7 +818,7 @@
    Documentation Version
    latex_repr=None,
    -)[source] +)[source]

    This class represent prefixes, with their name, symbol and factor.

    Prefixes are used to create derived units from a given unit. They should always be encapsulated into units.

    diff --git a/dev/modules/physics/units/quantities.html b/dev/modules/physics/units/quantities.html index af2cb431dde..e635f1374b8 100644 --- a/dev/modules/physics/units/quantities.html +++ b/dev/modules/physics/units/quantities.html @@ -819,7 +819,7 @@
    Documentation Version
    **assumptions,
    -)[source] +)[source]

    Physical quantity: can be a unit of measure, a constant or a generic quantity.

    @@ -830,7 +830,7 @@
    Documentation Version
    -convert_to(other, unit_system='SI')[source]
    +convert_to(other, unit_system='SI')[source]

    Convert the quantity to another quantity of same dimensions.

    Examples

    >>> from sympy.physics.units import speed_of_light, meter, second
    @@ -874,7 +874,7 @@ 
    Documentation Version
    reference_quantity,
    -)[source] +)[source]

    Setting a scale factor that is valid across all unit system.

@@ -885,7 +885,7 @@
Documentation Version

Several methods to simplify expressions involving unit objects.

-sympy.physics.units.util.convert_to(expr, target_units, unit_system='SI')[source]
+sympy.physics.units.util.convert_to(expr, target_units, unit_system='SI')[source]

Convert expr to the same expression with all of its units and quantities represented as factors of target_units, whenever the dimension is compatible.

target_units may be a single unit/quantity, or a collection of diff --git a/dev/modules/physics/units/unitsystem.html b/dev/modules/physics/units/unitsystem.html index 9a75d722b0c..dc712097965 100644 --- a/dev/modules/physics/units/unitsystem.html +++ b/dev/modules/physics/units/unitsystem.html @@ -817,7 +817,7 @@

Documentation Version
derived_units: Dict[Dimension, Quantity] = {},
-)[source] +)[source]

UnitSystem represents a coherent set of units.

A unit system is basically a dimension system with notions of scales. Many of the methods are defined in the same way.

@@ -842,7 +842,7 @@
Documentation Version
derived_units: Dict[Dimension, Quantity] = {},
-)[source] +)[source]

Extend the current system into a new one.

Take the base and normal units of the current system to merge them to the base and normal units given in argument. @@ -851,7 +851,7 @@

Documentation Version
-get_units_non_prefixed() Set[Quantity][source]
+get_units_non_prefixed() Set[Quantity][source]

Return the units of the system that do not have a prefix.

diff --git a/dev/modules/physics/vector/api/classes.html b/dev/modules/physics/vector/api/classes.html index 726c8b4cb75..a6397b1b831 100644 --- a/dev/modules/physics/vector/api/classes.html +++ b/dev/modules/physics/vector/api/classes.html @@ -805,7 +805,7 @@
Documentation Version

Essential Classes

-class sympy.physics.vector.frame.CoordinateSym(name, frame, index)[source]
+class sympy.physics.vector.frame.CoordinateSym(name, frame, index)[source]

A coordinate symbol/base scalar associated wrt a Reference Frame.

Ideally, users should not instantiate this class. Instances of this class must only be accessed through the corresponding frame @@ -853,7 +853,7 @@

Essential Classesvariables=None,

-)[source] +)[source]

A reference frame in classical mechanics.

ReferenceFrame is a class used to represent a reference frame in classical mechanics. It has a standard basis of three unit vectors in the frame’s @@ -864,7 +864,7 @@

Essential Classes
-ang_acc_in(otherframe)[source]
+ang_acc_in(otherframe)[source]

Returns the angular acceleration Vector of the ReferenceFrame.

Effectively returns the Vector:

N_alpha_B

@@ -892,7 +892,7 @@

Essential Classes
-ang_vel_in(otherframe)[source]
+ang_vel_in(otherframe)[source]

Returns the angular velocity Vector of the ReferenceFrame.

Effectively returns the Vector:

^N omega ^B

@@ -920,7 +920,7 @@

Essential Classes
-dcm(otherframe)[source]
+dcm(otherframe)[source]

Returns the direction cosine matrix of this reference frame relative to the provided reference frame.

The returned matrix can be used to express the orthogonal unit vectors @@ -997,7 +997,7 @@

Essential Classesrot_order='',

-)[source] +)[source]

Sets the orientation of this reference frame relative to another (parent) reference frame.

@@ -1060,7 +1060,7 @@

Essential Classes
-orient_axis(parent, axis, angle)[source]
+orient_axis(parent, axis, angle)[source]

Sets the orientation of this reference frame with respect to a parent reference frame by rotating through an angle about an axis fixed in the parent reference frame.

@@ -1134,7 +1134,7 @@

Essential Classesrotation_order,

-)[source] +)[source]

Rotates this reference frame relative to the parent reference frame by right hand rotating through three successive body fixed simple axis rotations. Each subsequent axis of rotation is about the “body fixed” @@ -1219,7 +1219,7 @@

Essential Classes
-orient_dcm(parent, dcm)[source]
+orient_dcm(parent, dcm)[source]

Sets the orientation of this reference frame relative to another (parent) reference frame using a direction cosine matrix that describes the rotation from the child to the parent.

@@ -1278,7 +1278,7 @@

Essential Classes
-orient_quaternion(parent, numbers)[source]
+orient_quaternion(parent, numbers)[source]

Sets the orientation of this reference frame relative to a parent reference frame via an orientation quaternion. An orientation quaternion is defined as a finite rotation a unit vector, (lambda_x, @@ -1342,7 +1342,7 @@

Essential Classesrotation_order,

-)[source] +)[source]

Rotates this reference frame relative to the parent reference frame by right hand rotating through three successive space fixed simple axis rotations. Each subsequent axis of rotation is about the “space fixed” @@ -1442,7 +1442,7 @@

Essential Classeslatexs=None,

-)[source] +)[source]

Returns a new reference frame oriented with respect to this reference frame.

See ReferenceFrame.orient() for detailed examples of how to orient @@ -1541,7 +1541,7 @@

Essential Classes*gen_speeds,

-)[source] +)[source]

Returns the partial angular velocities of this frame in the given frame with respect to one or more provided generalized speeds.

@@ -1579,7 +1579,7 @@

Essential Classes
-set_ang_acc(otherframe, value)[source]
+set_ang_acc(otherframe, value)[source]

Define the angular acceleration Vector in a ReferenceFrame.

Defines the angular acceleration of this ReferenceFrame, in another. Angular acceleration can be defined with respect to multiple different @@ -1611,7 +1611,7 @@

Essential Classes
-set_ang_vel(otherframe, value)[source]
+set_ang_vel(otherframe, value)[source]

Define the angular velocity vector in a ReferenceFrame.

Defines the angular velocity of this ReferenceFrame, in another. Angular velocity can be defined with respect to multiple different @@ -1649,7 +1649,7 @@

Essential Classes
-variable_map(otherframe)[source]
+variable_map(otherframe)[source]

Returns a dictionary which expresses the coordinate variables of this frame in terms of the variables of otherframe.

If Vector.simp is True, returns a simplified version of the mapped @@ -1750,7 +1750,7 @@

Essential Classes
-class sympy.physics.vector.vector.Vector(inlist)[source]
+class sympy.physics.vector.vector.Vector(inlist)[source]

The class used to define vectors.

It along with ReferenceFrame are the building blocks of describing a classical mechanics system in PyDy and sympy.physics.vector.

@@ -1766,7 +1766,7 @@

Essential Classes
-angle_between(vec)[source]
+angle_between(vec)[source]

Returns the smallest angle between Vector ‘vec’ and self.

Warning

@@ -1797,13 +1797,13 @@

Essential Classes
-applyfunc(f)[source]
+applyfunc(f)[source]

Apply a function to each component of a vector.

-cross(other)[source]
+cross(other)[source]

The cross product operator for two Vectors.

Returns a Vector, expressed in the same ReferenceFrames as self.

@@ -1833,7 +1833,7 @@

Essential Classes
-diff(var, frame, var_in_dcm=True)[source]
+diff(var, frame, var_in_dcm=True)[source]

Returns the partial derivative of the vector with respect to a variable in the provided reference frame.

@@ -1881,13 +1881,13 @@

Essential Classes
-doit(**hints)[source]
+doit(**hints)[source]

Calls .doit() on each term in the Vector

-dot(other)[source]
+dot(other)[source]

Dot product of two vectors.

Returns a scalar, the dot product of the two Vectors

@@ -1916,7 +1916,7 @@

Essential Classes
-dt(otherframe)[source]
+dt(otherframe)[source]

Returns a Vector which is the time derivative of the self Vector, taken in frame otherframe.

Calls the global time_derivative method

@@ -1932,7 +1932,7 @@

Essential Classes
-express(otherframe, variables=False)[source]
+express(otherframe, variables=False)[source]

Returns a Vector equivalent to this one, expressed in otherframe. Uses the global express method.

@@ -1963,7 +1963,7 @@

Essential Classes
-free_dynamicsymbols(reference_frame)[source]
+free_dynamicsymbols(reference_frame)[source]

Returns the free dynamic symbols (functions of time t) in the measure numbers of the vector expressed in the given reference frame.

@@ -1986,7 +1986,7 @@

Essential Classes
-free_symbols(reference_frame)[source]
+free_symbols(reference_frame)[source]

Returns the free symbols in the measure numbers of the vector expressed in the given reference frame.

@@ -2015,7 +2015,7 @@

Essential Classes
-magnitude()[source]
+magnitude()[source]

Returns the magnitude (Euclidean norm) of self.

Warning

@@ -2028,13 +2028,13 @@

Essential Classes
-normalize()[source]
+normalize()[source]

Returns a Vector of magnitude 1, codirectional with self.

-outer(other)[source]
+outer(other)[source]

Outer product between two Vectors.

A rank increasing operation, which returns a Dyadic from two Vectors

@@ -2056,7 +2056,7 @@

Essential Classes
-separate()[source]
+separate()[source]

The constituents of this vector in different reference frames, as per its definition.

Returns a dict mapping each ReferenceFrame to the corresponding @@ -2074,13 +2074,13 @@

Essential Classes
-simplify()[source]
+simplify()[source]

Returns a simplified Vector.

-subs(*args, **kwargs)[source]
+subs(*args, **kwargs)[source]

Substitution on the Vector.

Examples

>>> from sympy.physics.vector import ReferenceFrame
@@ -2096,7 +2096,7 @@ 

Essential Classes
-to_matrix(reference_frame)[source]
+to_matrix(reference_frame)[source]

Returns the matrix form of the vector with respect to the given frame.

@@ -2137,7 +2137,7 @@

Essential Classes
-xreplace(rule)[source]
+xreplace(rule)[source]

Replace occurrences of objects within the measure numbers of the vector.

@@ -2179,7 +2179,7 @@

Essential Classes
-class sympy.physics.vector.dyadic.Dyadic(inlist)[source]
+class sympy.physics.vector.dyadic.Dyadic(inlist)[source]

A Dyadic object.

See: https://en.wikipedia.org/wiki/Dyadic_tensor @@ -2189,13 +2189,13 @@

Essential Classes
-applyfunc(f)[source]
+applyfunc(f)[source]

Apply a function to each component of a Dyadic.

-cross(other)[source]
+cross(other)[source]

Returns the dyadic resulting from the dyadic vector cross product: Dyadic x Vector.

@@ -2218,13 +2218,13 @@

Essential Classes
-doit(**hints)[source]
+doit(**hints)[source]

Calls .doit() on each term in the Dyadic

-dot(other)[source]
+dot(other)[source]

The inner product operator for a Dyadic and a Dyadic or Vector.

Parameters:
@@ -2249,7 +2249,7 @@

Essential Classes
-dt(frame)[source]
+dt(frame)[source]

Take the time derivative of this Dyadic in a frame.

This function calls the global time_derivative method

@@ -2276,7 +2276,7 @@

Essential Classes
-express(frame1, frame2=None)[source]
+express(frame1, frame2=None)[source]

Expresses this Dyadic in alternate frame(s)

The first frame is the list side expression, the second frame is the right side; if Dyadic is in form A.x|B.y, you can express it in two @@ -2317,13 +2317,13 @@

Essential Classes
-simplify()[source]
+simplify()[source]

Returns a simplified Dyadic.

-subs(*args, **kwargs)[source]
+subs(*args, **kwargs)[source]

Substitution on the Dyadic.

Examples

>>> from sympy.physics.vector import ReferenceFrame
@@ -2346,7 +2346,7 @@ 

Essential Classessecond_reference_frame=None,

-)[source] +)[source]

Returns the matrix form of the dyadic with respect to one or two reference frames.

@@ -2395,7 +2395,7 @@

Essential Classes
-xreplace(rule)[source]
+xreplace(rule)[source]

Replace occurrences of objects within the measure numbers of the Dyadic.

diff --git a/dev/modules/physics/vector/api/fieldfunctions.html b/dev/modules/physics/vector/api/fieldfunctions.html index 707776cbedd..0d256a3cbed 100644 --- a/dev/modules/physics/vector/api/fieldfunctions.html +++ b/dev/modules/physics/vector/api/fieldfunctions.html @@ -809,7 +809,7 @@

Field operation functions
-sympy.physics.vector.fieldfunctions.curl(vect, frame)[source]
+sympy.physics.vector.fieldfunctions.curl(vect, frame)[source]

Returns the curl of a vector field computed wrt the coordinate symbols of the given frame.

@@ -840,7 +840,7 @@

Field operation functions
-sympy.physics.vector.fieldfunctions.divergence(vect, frame)[source]
+sympy.physics.vector.fieldfunctions.divergence(vect, frame)[source]

Returns the divergence of a vector field computed wrt the coordinate symbols of the given frame.

@@ -871,7 +871,7 @@

Field operation functions
-sympy.physics.vector.fieldfunctions.gradient(scalar, frame)[source]
+sympy.physics.vector.fieldfunctions.gradient(scalar, frame)[source]

Returns the vector gradient of a scalar field computed wrt the coordinate symbols of the given frame.

@@ -902,7 +902,7 @@

Field operation functions
-sympy.physics.vector.fieldfunctions.scalar_potential(field, frame)[source]
+sympy.physics.vector.fieldfunctions.scalar_potential(field, frame)[source]

Returns the scalar potential function of a field in a given frame (without the added integration constant).

@@ -944,7 +944,7 @@

Field operation functionsorigin,

-)[source] +)[source]

Returns the scalar potential difference between two points in a certain frame, wrt a given field.

If a scalar field is provided, its values at the two points are @@ -997,7 +997,7 @@

Field operation functions

-sympy.physics.vector.fieldfunctions.is_conservative(field)[source]
+sympy.physics.vector.fieldfunctions.is_conservative(field)[source]

Checks if a field is conservative.

Parameters:
@@ -1021,7 +1021,7 @@

Checking the type of vector field
-sympy.physics.vector.fieldfunctions.is_solenoidal(field)[source]
+sympy.physics.vector.fieldfunctions.is_solenoidal(field)[source]

Checks if a field is solenoidal.

Parameters:
diff --git a/dev/modules/physics/vector/api/functions.html b/dev/modules/physics/vector/api/functions.html index 053614535a1..5851d7ceb4c 100644 --- a/dev/modules/physics/vector/api/functions.html +++ b/dev/modules/physics/vector/api/functions.html @@ -805,7 +805,7 @@
Documentation Version

Essential Functions (Docstrings)

-sympy.physics.vector.dynamicsymbols(names, level=0, **assumptions)[source]
+sympy.physics.vector.dynamicsymbols(names, level=0, **assumptions)[source]

Uses symbols and Function for functions of time.

Creates a SymPy UndefinedFunction, which is then initialized as a function of a variable, the default being Symbol(‘t’).

@@ -874,7 +874,7 @@

Essential Functions (Docstrings)
-sympy.physics.vector.functions.dot(vec1, vec2)[source]
+sympy.physics.vector.functions.dot(vec1, vec2)[source]

Dot product convenience wrapper for Vector.dot(): Dot product of two vectors.

@@ -906,7 +906,7 @@

Essential Functions (Docstrings)
-sympy.physics.vector.functions.cross(vec1, vec2)[source]
+sympy.physics.vector.functions.cross(vec1, vec2)[source]

Cross product convenience wrapper for Vector.cross(): The cross product operator for two Vectors.

@@ -939,7 +939,7 @@

Essential Functions (Docstrings)
-sympy.physics.vector.functions.outer(vec1, vec2)[source]
+sympy.physics.vector.functions.outer(vec1, vec2)[source]

Outer product convenience wrapper for Vector.outer(): Outer product between two Vectors.

@@ -964,7 +964,7 @@

Essential Functions (Docstrings)
-sympy.physics.vector.functions.express(expr, frame, frame2=None, variables=False)[source]
+sympy.physics.vector.functions.express(expr, frame, frame2=None, variables=False)[source]

Global function for ‘express’ functionality.

Re-expresses a Vector, scalar(sympyfiable) or Dyadic in given frame.

Refer to the local methods of Vector and Dyadic for details. @@ -1014,7 +1014,7 @@

Essential Functions (Docstrings)
-sympy.physics.vector.functions.time_derivative(expr, frame, order=1)[source]
+sympy.physics.vector.functions.time_derivative(expr, frame, order=1)[source]

Calculate the time derivative of a vector/scalar field function or dyadic expression in given frame.

diff --git a/dev/modules/physics/vector/api/kinematics.html b/dev/modules/physics/vector/api/kinematics.html index a4744aac077..607428d34ae 100644 --- a/dev/modules/physics/vector/api/kinematics.html +++ b/dev/modules/physics/vector/api/kinematics.html @@ -805,7 +805,7 @@
Documentation Version

Kinematics (Docstrings)

-class sympy.physics.vector.point.Point(name)[source]
+class sympy.physics.vector.point.Point(name)[source]

This object represents a point in a dynamic system.

It stores the: position, velocity, and acceleration of a point. The position is a vector defined as the vector distance from a parent @@ -858,7 +858,7 @@

Documentation Version
interframe,
-)[source] +)[source]

Sets the acceleration of this point with the 1-point theory.

The 1-point theory for point acceleration looks like this:

^N a^P = ^B a^P + ^N a^O + ^N alpha^B x r^OP + ^N omega^B x (^N omega^B @@ -913,7 +913,7 @@

Documentation Version
fixedframe,
-)[source] +)[source]

Sets the acceleration of this point with the 2-point theory.

The 2-point theory for point acceleration looks like this:

^N a^P = ^N a^O + ^N alpha^B x r^OP + ^N omega^B x (^N omega^B x r^OP)

@@ -954,7 +954,7 @@
Documentation Version
-acc(frame)[source]
+acc(frame)[source]

The acceleration Vector of this Point in a ReferenceFrame.

Parameters:
@@ -978,7 +978,7 @@
Documentation Version
-locatenew(name, value)[source]
+locatenew(name, value)[source]

Creates a new point with a position defined from this point.

Parameters:
@@ -1003,7 +1003,7 @@
Documentation Version
-partial_velocity(frame, *gen_speeds)[source]
+partial_velocity(frame, *gen_speeds)[source]

Returns the partial velocities of the linear velocity vector of this point in the given frame with respect to one or more provided generalized speeds.

@@ -1044,7 +1044,7 @@
Documentation Version
-pos_from(otherpoint)[source]
+pos_from(otherpoint)[source]

Returns a Vector distance between this Point and the other Point.

Parameters:
@@ -1068,7 +1068,7 @@
Documentation Version
-set_acc(frame, value)[source]
+set_acc(frame, value)[source]

Used to set the acceleration of this Point in a ReferenceFrame.

Parameters:
@@ -1095,7 +1095,7 @@
Documentation Version
-set_pos(otherpoint, value)[source]
+set_pos(otherpoint, value)[source]

Used to set the position of this point w.r.t. another point.

Parameters:
@@ -1123,7 +1123,7 @@
Documentation Version
-set_vel(frame, value)[source]
+set_vel(frame, value)[source]

Sets the velocity Vector of this Point in a ReferenceFrame.

Parameters:
@@ -1158,7 +1158,7 @@
Documentation Version
interframe,
-)[source] +)[source]

Sets the velocity of this point with the 1-point theory.

The 1-point theory for point velocity looks like this:

^N v^P = ^B v^P + ^N v^O + ^N omega^B x r^OP

@@ -1212,7 +1212,7 @@
Documentation Version
fixedframe,
-)[source] +)[source]

Sets the velocity of this point with the 2-point theory.

The 2-point theory for point velocity looks like this:

^N v^P = ^N v^O + ^N omega^B x r^OP

@@ -1253,7 +1253,7 @@
Documentation Version
-vel(frame)[source]
+vel(frame)[source]

The velocity Vector of this Point in the ReferenceFrame.

Parameters:
@@ -1296,7 +1296,7 @@
Documentation Version

kinematic_equations

-sympy.physics.vector.functions.get_motion_params(frame, **kwargs)[source]
+sympy.physics.vector.functions.get_motion_params(frame, **kwargs)[source]

Returns the three motion parameters - (acceleration, velocity, and position) as vectorial functions of time in the given frame.

If a higher order differential function is provided, the lower order @@ -1377,7 +1377,7 @@

Documentation Version
rot_order='',
-)[source] +)[source]

Gives equations relating the qdot’s to u’s for a rotation type.

Supply rotation type and order as in orient. Speeds are assumed to be body-fixed; if we are defining the orientation of B in A using by rot_type, @@ -1418,7 +1418,7 @@

Documentation Version
-sympy.physics.vector.functions.partial_velocity(vel_vecs, gen_speeds, frame)[source]
+sympy.physics.vector.functions.partial_velocity(vel_vecs, gen_speeds, frame)[source]

Returns a list of partial velocities with respect to the provided generalized speeds in the given reference frame for each of the supplied velocity vectors.

diff --git a/dev/modules/physics/vector/api/printing.html b/dev/modules/physics/vector/api/printing.html index 2143e2385dd..6e6e74941ae 100644 --- a/dev/modules/physics/vector/api/printing.html +++ b/dev/modules/physics/vector/api/printing.html @@ -805,7 +805,7 @@
Documentation Version

Printing (Docstrings)

-sympy.physics.vector.printing.init_vprinting(**kwargs)[source]
+sympy.physics.vector.printing.init_vprinting(**kwargs)[source]

Initializes time derivative printing for all SymPy objects, i.e. any functions of time will be displayed in a more compact notation. The main benefit of this is for printing of time derivatives; instead of @@ -953,7 +953,7 @@

Printing (Docstrings)
-sympy.physics.vector.printing.vprint(expr, **settings)[source]
+sympy.physics.vector.printing.vprint(expr, **settings)[source]

Function for printing of expressions generated in the sympy.physics vector package.

Extends SymPy’s StrPrinter, takes the same setting accepted by SymPy’s @@ -983,7 +983,7 @@

Printing (Docstrings)
-sympy.physics.vector.printing.vpprint(expr, **settings)[source]
+sympy.physics.vector.printing.vpprint(expr, **settings)[source]

Function for pretty printing of expressions generated in the sympy.physics vector package.

Mainly used for expressions not inside a vector; the output of running @@ -1005,7 +1005,7 @@

Printing (Docstrings)
-sympy.physics.vector.printing.vlatex(expr, **settings)[source]
+sympy.physics.vector.printing.vlatex(expr, **settings)[source]

Function for printing latex representation of sympy.physics.vector objects.

For latex representation of Vectors, Dyadics, and dynamicsymbols. Takes the diff --git a/dev/modules/physics/wigner.html b/dev/modules/physics/wigner.html index cc7be5efef3..3e6174a9674 100644 --- a/dev/modules/physics/wigner.html +++ b/dev/modules/physics/wigner.html @@ -871,7 +871,7 @@

Authors
-sympy.physics.wigner.clebsch_gordan(j_1, j_2, j_3, m_1, m_2, m_3)[source]
+sympy.physics.wigner.clebsch_gordan(j_1, j_2, j_3, m_1, m_2, m_3)[source]

Calculates the Clebsch-Gordan coefficient. \(\left\langle j_1 m_1 \; j_2 m_2 | j_3 m_3 \right\rangle\).

The reference for this function is [Edmonds74].

@@ -916,7 +916,7 @@

Authors
-sympy.physics.wigner.dot_rot_grad_Ynm(j, p, l, m, theta, phi)[source]
+sympy.physics.wigner.dot_rot_grad_Ynm(j, p, l, m, theta, phi)[source]

Returns dot product of rotational gradients of spherical harmonics.

Explanation

This function returns the right hand side of the following expression:

@@ -941,7 +941,7 @@

Authors
-sympy.physics.wigner.gaunt(l_1, l_2, l_3, m_1, m_2, m_3, prec=None)[source]
+sympy.physics.wigner.gaunt(l_1, l_2, l_3, m_1, m_2, m_3, prec=None)[source]

Calculate the Gaunt coefficient.

Parameters:
@@ -1036,7 +1036,7 @@

Authors
-sympy.physics.wigner.racah(aa, bb, cc, dd, ee, ff, prec=None)[source]
+sympy.physics.wigner.racah(aa, bb, cc, dd, ee, ff, prec=None)[source]

Calculate the Racah symbol \(W(a,b,c,d;e,f)\).

Parameters:
@@ -1096,7 +1096,7 @@

Authors
prec=None,

-)[source] +)[source]

Calculate the real Gaunt coefficient.

Parameters:
@@ -1211,7 +1211,7 @@

Authors
-sympy.physics.wigner.wigner_3j(j_1, j_2, j_3, m_1, m_2, m_3)[source]
+sympy.physics.wigner.wigner_3j(j_1, j_2, j_3, m_1, m_2, m_3)[source]

Calculate the Wigner 3j symbol \(\operatorname{Wigner3j}(j_1,j_2,j_3,m_1,m_2,m_3)\).

Parameters:
@@ -1294,7 +1294,7 @@

Authors
-sympy.physics.wigner.wigner_6j(j_1, j_2, j_3, j_4, j_5, j_6, prec=None)[source]
+sympy.physics.wigner.wigner_6j(j_1, j_2, j_3, j_4, j_5, j_6, prec=None)[source]

Calculate the Wigner 6j symbol \(\operatorname{Wigner6j}(j_1,j_2,j_3,j_4,j_5,j_6)\).

Parameters:
@@ -1398,7 +1398,7 @@

Authors
prec=None,

-)[source] +)[source]

Calculate the Wigner 9j symbol \(\operatorname{Wigner9j}(j_1,j_2,j_3,j_4,j_5,j_6,j_7,j_8,j_9)\).

@@ -1450,7 +1450,7 @@

Authors
-sympy.physics.wigner.wigner_d(J, alpha, beta, gamma)[source]
+sympy.physics.wigner.wigner_d(J, alpha, beta, gamma)[source]

Return the Wigner D matrix for angular momentum J.

Returns:
@@ -1500,7 +1500,7 @@

Authors
-sympy.physics.wigner.wigner_d_small(J, beta)[source]
+sympy.physics.wigner.wigner_d_small(J, beta)[source]

Return the small Wigner d matrix for angular momentum J.

Returns:
diff --git a/dev/modules/plotting.html b/dev/modules/plotting.html index 3a1ac5d886e..f6bd78710a2 100644 --- a/dev/modules/plotting.html +++ b/dev/modules/plotting.html @@ -853,7 +853,7 @@

Plot Class**kwargs,

-)[source] +)[source]

Base class for all backends. A backend represents the plotting library, which implements the necessary functionalities in order to use SymPy plotting functions.

@@ -1010,7 +1010,7 @@

Plot Class
-append(arg)[source]
+append(arg)[source]

Adds an element from a plot’s series to an existing plot.

Examples

Consider two Plot objects, p1 and p2. To add the @@ -1041,7 +1041,7 @@

Plot Class
-extend(arg)[source]
+extend(arg)[source]

Adds all series from another plot.

Examples

Consider two Plot objects, p1 and p2. To add the @@ -1097,7 +1097,7 @@

Plot Class

-sympy.plotting.plot.plot(*args, show=True, **kwargs)[source]
+sympy.plotting.plot.plot(*args, show=True, **kwargs)[source]

Plots a function of a single variable as a curve.

Parameters:
@@ -1306,7 +1306,7 @@

Plotting Function Reference
-sympy.plotting.plot.plot_parametric(*args, show=True, **kwargs)[source]
+sympy.plotting.plot.plot_parametric(*args, show=True, **kwargs)[source]

Plots a 2D parametric curve.

Parameters:
@@ -1491,7 +1491,7 @@

Plotting Function Reference
-sympy.plotting.plot.plot3d(*args, show=True, **kwargs)[source]
+sympy.plotting.plot.plot3d(*args, show=True, **kwargs)[source]

Plots a 3D surface plot.

Usage

Single plot

@@ -1590,7 +1590,7 @@

Plotting Function Reference
-sympy.plotting.plot.plot3d_parametric_line(*args, show=True, **kwargs)[source]
+sympy.plotting.plot.plot3d_parametric_line(*args, show=True, **kwargs)[source]

Plots a 3D parametric line plot.

Usage

Single plot:

@@ -1684,7 +1684,7 @@

Plotting Function Reference**kwargs,

-)[source] +)[source]

Plots a 3D parametric surface plot.

Explanation

Single plot.

@@ -1774,7 +1774,7 @@

Plotting Function Reference**kwargs,

-)[source] +)[source]

A plot function to plot implicit equations / inequalities.

Arguments

    @@ -1933,7 +1933,7 @@

    PlotGrid Class**kwargs,

-)[source] +)[source]

This class helps to plot subplots from already created SymPy plots in a single figure.

Examples

@@ -2029,7 +2029,7 @@

PlotGrid Class

-class sympy.plotting.series.BaseSeries(*args, **kwargs)[source]
+class sympy.plotting.series.BaseSeries(*args, **kwargs)[source]

Base class for the data objects containing stuff to be plotted.

Notes

The backend should check if it supports the data series that is given. @@ -2044,7 +2044,7 @@

Series Classes
-eval_color_func(*args)[source]
+eval_color_func(*args)[source]

Evaluate the color function.

Parameters:
@@ -2070,7 +2070,7 @@

Series Classes
-get_data()[source]
+get_data()[source]

Compute and returns the numerical data.

The number of parameters returned by this method depends on the specific instance. If s is the series, make sure to read @@ -2086,7 +2086,7 @@

Series Classeswrapper='$%s$',

-)[source] +)[source]

Return the label to be used to display the expression.

Parameters:
@@ -2134,7 +2134,7 @@

Series Classes
-class sympy.plotting.series.Line2DBaseSeries(**kwargs)[source]
+class sympy.plotting.series.Line2DBaseSeries(**kwargs)[source]

A base class for 2D lines.

  • adding the label, steps and only_integers options

  • @@ -2143,7 +2143,7 @@

    Series Classes
    -get_data()[source]
    +get_data()[source]

    Return coordinates for plotting the line.

    Returns:
    @@ -2183,11 +2183,11 @@

    Series Classes**kwargs,

-)[source] +)[source]

Representation for a line consisting of a SymPy expression over a range.

-get_points()[source]
+get_points()[source]

Return lists of coordinates for plotting. Depending on the adaptive option, this function will either use an adaptive algorithm or it will uniformly sample the expression over the provided range.

@@ -2223,14 +2223,14 @@

Series Classes**kwargs,

-)[source] +)[source]

Representation for a line consisting of two parametric SymPy expressions over a range.

-class sympy.plotting.series.Line3DBaseSeries[source]
+class sympy.plotting.series.Line3DBaseSeries[source]

A base class for 3D lines.

Most of the stuff is derived from Line2DBaseSeries.

@@ -2248,14 +2248,14 @@

Series Classes**kwargs,

-)[source] +)[source]

Representation for a 3D line consisting of three parametric SymPy expressions and a range.

-class sympy.plotting.series.SurfaceBaseSeries(*args, **kwargs)[source]
+class sympy.plotting.series.SurfaceBaseSeries(*args, **kwargs)[source]

A base class for 3D surfaces.

@@ -2271,12 +2271,12 @@

Series Classes**kwargs,

-)[source] +)[source]

Representation for a 3D surface consisting of a SymPy expression and 2D range.

-get_data()[source]
+get_data()[source]

Return arrays of coordinates for plotting.

Returns:
@@ -2298,7 +2298,7 @@

Series Classes
-get_meshes()[source]
+get_meshes()[source]

Return the x,y,z coordinates for plotting the surface. This function is available for back-compatibility purposes. Consider using get_data() instead.

@@ -2320,12 +2320,12 @@

Series Classes**kwargs,

-)[source] +)[source]

Representation for a 3D surface consisting of three parametric SymPy expressions and a range.

-get_data()[source]
+get_data()[source]

Return arrays of coordinates for plotting.

Returns:
@@ -2355,7 +2355,7 @@

Series Classes
-get_meshes()[source]
+get_meshes()[source]

Return the x,y,z coordinates for plotting the surface. This function is available for back-compatibility purposes. Consider using get_data() instead.

@@ -2375,11 +2375,11 @@

Series Classes**kwargs,

-)[source] +)[source]

Representation for 2D Implicit plot.

-get_data()[source]
+get_data()[source]

Returns numerical data.

Returns:
@@ -2416,7 +2416,7 @@

Series Classeswrapper='$%s$',

-)[source] +)[source]

Return the label to be used to display the expression.

Parameters:
@@ -2444,12 +2444,12 @@

Series Classes

-class sympy.plotting.plot.MatplotlibBackend(*series, **kwargs)[source]
+class sympy.plotting.plot.MatplotlibBackend(*series, **kwargs)[source]

This class implements the functionalities to use Matplotlib with SymPy plotting functions.

-static get_segments(x, y, z=None)[source]
+static get_segments(x, y, z=None)[source]

Convert two list of coordinates to a list of segments to be used with Matplotlib’s LineCollection.

@@ -2472,7 +2472,7 @@

Backends
-process_series()[source]
+process_series()[source]

Iterates over every Plot object and further calls _process_series()

@@ -2481,7 +2481,7 @@

Backends
-class sympy.plotting.plot.TextBackend(*args, **kwargs)[source]
+class sympy.plotting.plot.TextBackend(*args, **kwargs)[source]
@@ -2715,7 +2715,7 @@

Using Custom Color Functions

-sympy.plotting.textplot.textplot(expr, a, b, W=55, H=21)[source]
+sympy.plotting.textplot.textplot(expr, a, b, W=55, H=21)[source]

Print a crude ASCII art plot of the SymPy expression ‘expr’ (which should contain a single symbol, e.g. x or something else) over the interval [a, b].

diff --git a/dev/modules/polys/agca.html b/dev/modules/polys/agca.html index fd578c03b33..cfbe5aa8100 100644 --- a/dev/modules/polys/agca.html +++ b/dev/modules/polys/agca.html @@ -903,11 +903,11 @@

Base Rings
-class sympy.polys.domains.ring.Ring[source]
+class sympy.polys.domains.ring.Ring[source]

Represents a ring domain.

-free_module(rank)[source]
+free_module(rank)[source]

Generate a free module of rank rank over self.

>>> from sympy.abc import x
 >>> from sympy import QQ
@@ -919,7 +919,7 @@ 

Base Rings
-ideal(*gens)[source]
+ideal(*gens)[source]

Generate an ideal of self.

>>> from sympy.abc import x
 >>> from sympy import QQ
@@ -931,7 +931,7 @@ 

Base Rings
-quotient_ring(e)[source]
+quotient_ring(e)[source]

Form a quotient ring of self.

Here e can be an ideal or an iterable.

>>> from sympy.abc import x
@@ -961,13 +961,13 @@ 

Base Ringsorder=None,

-)[source] +)[source]

A class for representing multivariate polynomial rings.

-class sympy.polys.domains.quotientring.QuotientRing(ring, ideal)[source]
+class sympy.polys.domains.quotientring.QuotientRing(ring, ideal)[source]

Class representing (commutative) quotient rings.

You should not usually instantiate this by hand, instead use the constructor from the base ring in the construction.

@@ -1047,7 +1047,7 @@

Modules, Ideals and their Elementary Properties
-class sympy.polys.agca.modules.Module(ring)[source]
+class sympy.polys.agca.modules.Module(ring)[source]

Abstract base class for modules.

Do not instantiate - use ring explicit constructors instead:

>>> from sympy import QQ
@@ -1072,56 +1072,56 @@ 

Modules, Ideals and their Elementary Properties
-contains(elem)[source]
+contains(elem)[source]

Return True if elem is an element of this module.

-convert(elem, M=None)[source]
+convert(elem, M=None)[source]

Convert elem into internal representation of this module.

If M is not None, it should be a module containing it.

-identity_hom()[source]
+identity_hom()[source]

Return the identity homomorphism on self.

-is_submodule(other)[source]
+is_submodule(other)[source]

Returns True if other is a submodule of self.

-is_zero()[source]
+is_zero()[source]

Returns True if self is a zero module.

-multiply_ideal(other)[source]
+multiply_ideal(other)[source]

Multiply self by the ideal other.

-quotient_module(other)[source]
+quotient_module(other)[source]

Generate a quotient module.

-submodule(*gens)[source]
+submodule(*gens)[source]

Generate a submodule.

-subset(other)[source]
+subset(other)[source]

Returns True if other is is a subset of self.

Examples

>>> from sympy.abc import x
@@ -1139,7 +1139,7 @@ 

Modules, Ideals and their Elementary Properties
-class sympy.polys.agca.modules.FreeModule(ring, rank)[source]
+class sympy.polys.agca.modules.FreeModule(ring, rank)[source]

Abstract base class for free modules.

Additional attributes:

    @@ -1151,7 +1151,7 @@

    Modules, Ideals and their Elementary Properties
    -basis()[source]
    +basis()[source]

    Return a set of basis elements.

    Examples

    >>> from sympy.abc import x
    @@ -1164,7 +1164,7 @@ 

    Modules, Ideals and their Elementary Properties
    -convert(elem, M=None)[source]
    +convert(elem, M=None)[source]

    Convert elem into the internal representation.

    This method is called implicitly whenever computations involve elements not in the internal representation.

    @@ -1180,13 +1180,13 @@

    Modules, Ideals and their Elementary Properties
    -dtype[source]
    +dtype[source]

    alias of FreeModuleElement

-identity_hom()[source]
+identity_hom()[source]

Return the identity homomorphism on self.

Examples

>>> from sympy.abc import x
@@ -1201,7 +1201,7 @@ 

Modules, Ideals and their Elementary Properties
-is_submodule(other)[source]
+is_submodule(other)[source]

Returns True if other is a submodule of self.

Examples

>>> from sympy.abc import x
@@ -1220,7 +1220,7 @@ 

Modules, Ideals and their Elementary Properties
-is_zero()[source]
+is_zero()[source]

Returns True if self is a zero module.

(If, as this implementation assumes, the coefficient ring is not the zero ring, then this is equivalent to the rank being zero.)

@@ -1237,7 +1237,7 @@

Modules, Ideals and their Elementary Properties
-multiply_ideal(other)[source]
+multiply_ideal(other)[source]

Multiply self by the ideal other.

Examples

>>> from sympy.abc import x
@@ -1252,7 +1252,7 @@ 

Modules, Ideals and their Elementary Properties
-quotient_module(submodule)[source]
+quotient_module(submodule)[source]

Return a quotient module.

Examples

>>> from sympy.abc import x
@@ -1273,13 +1273,13 @@ 

Modules, Ideals and their Elementary Properties
-class sympy.polys.agca.modules.FreeModuleElement(module, data)[source]
+class sympy.polys.agca.modules.FreeModuleElement(module, data)[source]

Element of a free module. Data stored as a tuple.

-class sympy.polys.agca.modules.SubModule(gens, container)[source]
+class sympy.polys.agca.modules.SubModule(gens, container)[source]

Base class for submodules.

Attributes:

    @@ -1301,7 +1301,7 @@

    Modules, Ideals and their Elementary Properties
    -convert(elem, M=None)[source]
    +convert(elem, M=None)[source]

    Convert elem into the internal represantition.

    Mostly called implicitly.

    Examples

    @@ -1316,7 +1316,7 @@

    Modules, Ideals and their Elementary Properties
    -identity_hom()[source]
    +identity_hom()[source]

    Return the identity homomorphism on self.

    Examples

    >>> from sympy.abc import x
    @@ -1331,7 +1331,7 @@ 

    Modules, Ideals and their Elementary Properties
    -in_terms_of_generators(e)[source]
    +in_terms_of_generators(e)[source]

    Express element e of self in terms of the generators.

    Examples

    >>> from sympy.abc import x
    @@ -1346,7 +1346,7 @@ 

    Modules, Ideals and their Elementary Properties
    -inclusion_hom()[source]
    +inclusion_hom()[source]

    Return a homomorphism representing the inclusion map of self.

    That is, the natural map from self to self.container.

    Examples

    @@ -1362,7 +1362,7 @@

    Modules, Ideals and their Elementary Properties
    -intersect(other, **options)[source]
    +intersect(other, **options)[source]

    Returns the intersection of self with submodule other.

    Examples

    >>> from sympy.abc import x, y
    @@ -1390,7 +1390,7 @@ 

    Modules, Ideals and their Elementary Properties
    -is_full_module()[source]
    +is_full_module()[source]

    Return True if self is the entire free module.

    Examples

    >>> from sympy.abc import x
    @@ -1406,7 +1406,7 @@ 

    Modules, Ideals and their Elementary Properties
    -is_submodule(other)[source]
    +is_submodule(other)[source]

    Returns True if other is a submodule of self.

    >>> from sympy.abc import x
     >>> from sympy import QQ
    @@ -1425,7 +1425,7 @@ 

    Modules, Ideals and their Elementary Properties
    -is_zero()[source]
    +is_zero()[source]

    Return True if self is a zero module.

    Examples

    >>> from sympy.abc import x
    @@ -1441,7 +1441,7 @@ 

    Modules, Ideals and their Elementary Properties
    -module_quotient(other, **options)[source]
    +module_quotient(other, **options)[source]

    Returns the module quotient of self by submodule other.

    That is, if self is the module \(M\) and other is \(N\), then return the ideal \(\{f \in R | fN \subset M\}\).

    @@ -1473,7 +1473,7 @@

    Modules, Ideals and their Elementary Properties
    -multiply_ideal(I)[source]
    +multiply_ideal(I)[source]

    Multiply self by the ideal I.

    Examples

    >>> from sympy.abc import x
    @@ -1488,7 +1488,7 @@ 

    Modules, Ideals and their Elementary Properties
    -quotient_module(other, **opts)[source]
    +quotient_module(other, **opts)[source]

    Return a quotient module.

    This is the same as taking a submodule of a quotient of the containing module.

    @@ -1511,7 +1511,7 @@

    Modules, Ideals and their Elementary Properties
    -reduce_element(x)[source]
    +reduce_element(x)[source]

    Reduce the element x of our ring modulo the ideal self.

    Here “reduce” has no specific meaning, it could return a unique normal form, simplify the expression a bit, or just do nothing.

    @@ -1519,7 +1519,7 @@

    Modules, Ideals and their Elementary Properties
    -submodule(*gens)[source]
    +submodule(*gens)[source]

    Generate a submodule.

    Examples

    >>> from sympy.abc import x
    @@ -1533,7 +1533,7 @@ 

    Modules, Ideals and their Elementary Properties
    -syzygy_module(**opts)[source]
    +syzygy_module(**opts)[source]

    Compute the syzygy module of the generators of self.

    Suppose \(M\) is generated by \(f_1, \ldots, f_n\) over the ring \(R\). Consider the homomorphism \(\phi: R^n \to M\), given by @@ -1559,7 +1559,7 @@

    Modules, Ideals and their Elementary Properties
    -union(other)[source]
    +union(other)[source]

    Returns the module generated by the union of self and other.

    Examples

    >>> from sympy.abc import x
    @@ -1593,7 +1593,7 @@ 

    Modules, Ideals and their Elementary Properties
    -class sympy.polys.agca.ideals.Ideal(ring)[source]
    +class sympy.polys.agca.ideals.Ideal(ring)[source]

    Abstract base class for ideals.

    Do not instantiate - use explicit constructors in the ring class instead:

    >>> from sympy import QQ
    @@ -1627,7 +1627,7 @@ 

    Modules, Ideals and their Elementary Properties
    -contains(elem)[source]
    +contains(elem)[source]

    Return True if elem is an element of this ideal.

    Examples

    >>> from sympy.abc import x
    @@ -1642,19 +1642,19 @@ 

    Modules, Ideals and their Elementary Properties
    -depth()[source]
    +depth()[source]

    Compute the depth of self.

-height()[source]
+height()[source]

Compute the height of self.

-intersect(J)[source]
+intersect(J)[source]

Compute the intersection of self with ideal J.

Examples

>>> from sympy.abc import x, y
@@ -1668,49 +1668,49 @@ 

Modules, Ideals and their Elementary Properties
-is_maximal()[source]
+is_maximal()[source]

Return True if self is a maximal ideal.

-is_primary()[source]
+is_primary()[source]

Return True if self is a primary ideal.

-is_prime()[source]
+is_prime()[source]

Return True if self is a prime ideal.

-is_principal()[source]
+is_principal()[source]

Return True if self is a principal ideal.

-is_radical()[source]
+is_radical()[source]

Return True if self is a radical ideal.

-is_whole_ring()[source]
+is_whole_ring()[source]

Return True if self is the whole ring.

-is_zero()[source]
+is_zero()[source]

Return True if self is the zero ideal.

-product(J)[source]
+product(J)[source]

Compute the ideal product of self and J.

That is, compute the ideal generated by products \(xy\), for \(x\) an element of self and \(y \in J\).

@@ -1725,7 +1725,7 @@

Modules, Ideals and their Elementary Properties
-quotient(J, **opts)[source]
+quotient(J, **opts)[source]

Compute the ideal quotient of self by J.

That is, if self is the ideal \(I\), compute the set \(I : J = \{x \in R | xJ \subset I \}\).

@@ -1741,13 +1741,13 @@

Modules, Ideals and their Elementary Properties
-radical()[source]
+radical()[source]

Compute the radical of self.

-reduce_element(x)[source]
+reduce_element(x)[source]

Reduce the element x of our ring modulo the ideal self.

Here “reduce” has no specific meaning: it could return a unique normal form, simplify the expression a bit, or just do nothing.

@@ -1755,7 +1755,7 @@

Modules, Ideals and their Elementary Properties
-saturate(J)[source]
+saturate(J)[source]

Compute the ideal saturation of self by J.

That is, if self is the ideal \(I\), compute the set \(I : J^\infty = \{x \in R | xJ^n \subset I \text{ for some } n\}\).

@@ -1763,7 +1763,7 @@

Modules, Ideals and their Elementary Properties
-subset(other)[source]
+subset(other)[source]

Returns True if other is is a subset of self.

Here other may be an ideal.

Examples

@@ -1782,7 +1782,7 @@

Modules, Ideals and their Elementary Properties
-union(J)[source]
+union(J)[source]

Compute the ideal generated by the union of self and J.

Examples

>>> from sympy.abc import x
@@ -1804,7 +1804,7 @@ 

Modules, Ideals and their Elementary Properties
-class sympy.polys.agca.modules.QuotientModule(ring, base, submodule)[source]
+class sympy.polys.agca.modules.QuotientModule(ring, base, submodule)[source]

Class for quotient modules.

Do not instantiate this directly. For subquotients, see the SubQuotientModule class.

@@ -1816,7 +1816,7 @@

Modules, Ideals and their Elementary Properties
-convert(elem, M=None)[source]
+convert(elem, M=None)[source]

Convert elem into the internal representation.

This method is called implicitly whenever computations involve elements not in the internal representation.

@@ -1832,13 +1832,13 @@

Modules, Ideals and their Elementary Properties
-dtype[source]
+dtype[source]

alias of QuotientModuleElement

-identity_hom()[source]
+identity_hom()[source]

Return the identity homomorphism on self.

Examples

>>> from sympy.abc import x
@@ -1854,7 +1854,7 @@ 

Modules, Ideals and their Elementary Properties
-is_submodule(other)[source]
+is_submodule(other)[source]

Return True if other is a submodule of self.

Examples

>>> from sympy.abc import x
@@ -1871,7 +1871,7 @@ 

Modules, Ideals and their Elementary Properties
-is_zero()[source]
+is_zero()[source]

Return True if self is a zero module.

This happens if and only if the base module is the same as the submodule being killed.

@@ -1889,7 +1889,7 @@

Modules, Ideals and their Elementary Properties
-quotient_hom()[source]
+quotient_hom()[source]

Return the quotient homomorphism to self.

That is, return a homomorphism representing the natural map from self.base to self.

@@ -1907,7 +1907,7 @@

Modules, Ideals and their Elementary Properties
-submodule(*gens, **opts)[source]
+submodule(*gens, **opts)[source]

Generate a submodule.

This is the same as taking a quotient of a submodule of the base module.

@@ -1925,11 +1925,11 @@

Modules, Ideals and their Elementary Properties
-class sympy.polys.agca.modules.QuotientModuleElement(module, data)[source]
+class sympy.polys.agca.modules.QuotientModuleElement(module, data)[source]

Element of a quotient module.

-eq(d1, d2)[source]
+eq(d1, d2)[source]

Equality comparison.

@@ -1937,7 +1937,7 @@

Modules, Ideals and their Elementary Properties
-class sympy.polys.agca.modules.SubQuotientModule(gens, container, **opts)[source]
+class sympy.polys.agca.modules.SubQuotientModule(gens, container, **opts)[source]

Submodule of a quotient module.

Equivalently, quotient module of a submodule.

Do not instantiate this, instead use the submodule or quotient_module @@ -1958,7 +1958,7 @@

Modules, Ideals and their Elementary Properties
-is_full_module()[source]
+is_full_module()[source]

Return True if self is the entire free module.

Examples

>>> from sympy.abc import x
@@ -1974,7 +1974,7 @@ 

Modules, Ideals and their Elementary Properties
-quotient_hom()[source]
+quotient_hom()[source]

Return the quotient homomorphism to self.

That is, return the natural map from self.base to self.

Examples

@@ -2053,7 +2053,7 @@

Module Homomorphisms and Syzygies
-sympy.polys.agca.homomorphisms.homomorphism(domain, codomain, matrix)[source]
+sympy.polys.agca.homomorphisms.homomorphism(domain, codomain, matrix)[source]

Create a homomorphism object.

This function tries to build a homomorphism from domain to codomain via the matrix matrix.

@@ -2114,7 +2114,7 @@

Module Homomorphisms and Syzygies
-class sympy.polys.agca.homomorphisms.ModuleHomomorphism(domain, codomain)[source]
+class sympy.polys.agca.homomorphisms.ModuleHomomorphism(domain, codomain)[source]

Abstract base class for module homomoprhisms. Do not instantiate.

Instead, use the homomorphism function:

>>> from sympy import QQ
@@ -2152,7 +2152,7 @@ 

Module Homomorphisms and Syzygies
-image()[source]
+image()[source]

Compute the image of self.

That is, if self is the homomorphism \(\phi: M \to N\), then compute \(im(\phi) = \{\phi(x) | x \in M \}\). This is a submodule of \(N\).

@@ -2171,7 +2171,7 @@

Module Homomorphisms and Syzygies
-is_injective()[source]
+is_injective()[source]

Return True if self is injective.

That is, check if the elements of the domain are mapped to the same codomain element.

@@ -2193,7 +2193,7 @@

Module Homomorphisms and Syzygies
-is_isomorphism()[source]
+is_isomorphism()[source]

Return True if self is an isomorphism.

That is, check if every element of the codomain has precisely one preimage. Equivalently, self is both injective and surjective.

@@ -2216,7 +2216,7 @@

Module Homomorphisms and Syzygies
-is_surjective()[source]
+is_surjective()[source]

Return True if self is surjective.

That is, check if every element of the codomain has at least one preimage.

@@ -2238,7 +2238,7 @@

Module Homomorphisms and Syzygies
-is_zero()[source]
+is_zero()[source]

Return True if self is a zero morphism.

That is, check if every element of the domain is mapped to zero under self.

@@ -2262,7 +2262,7 @@

Module Homomorphisms and Syzygies
-kernel()[source]
+kernel()[source]

Compute the kernel of self.

That is, if self is the homomorphism \(\phi: M \to N\), then compute \(ker(\phi) = \{x \in M | \phi(x) = 0\}\). This is a submodule of \(M\).

@@ -2281,7 +2281,7 @@

Module Homomorphisms and Syzygies
-quotient_codomain(sm)[source]
+quotient_codomain(sm)[source]

Return self with codomain replaced by codomain/sm.

Here sm must be a submodule of self.codomain.

Examples

@@ -2313,7 +2313,7 @@

Module Homomorphisms and Syzygies
-quotient_domain(sm)[source]
+quotient_domain(sm)[source]

Return self with domain replaced by domain/sm.

Here sm must be a submodule of self.kernel().

Examples

@@ -2338,7 +2338,7 @@

Module Homomorphisms and Syzygies
-restrict_codomain(sm)[source]
+restrict_codomain(sm)[source]

Return self, with codomain restricted to to sm.

Here sm has to be a submodule of self.codomain containing the image.

@@ -2364,7 +2364,7 @@

Module Homomorphisms and Syzygies
-restrict_domain(sm)[source]
+restrict_domain(sm)[source]

Return self, with the domain restricted to sm.

Here sm has to be a submodule of self.domain.

Examples

@@ -2417,7 +2417,7 @@

Finite Extensions\(t\).

-class sympy.polys.agca.extensions.MonogenicFiniteExtension(mod)[source]
+class sympy.polys.agca.extensions.MonogenicFiniteExtension(mod)[source]

Finite extension generated by an integral element.

The generator is defined by a monic univariate polynomial derived from the argument mod.

@@ -2453,7 +2453,7 @@

Finite Extensions
-dtype[source]
+dtype[source]

alias of ExtensionElement

@@ -2461,7 +2461,7 @@

Finite Extensions
-class sympy.polys.agca.extensions.ExtensionElement(rep, ext)[source]
+class sympy.polys.agca.extensions.ExtensionElement(rep, ext)[source]

Element of a finite extension.

A class of univariate polynomials modulo the modulus of the extension ext. It is represented by the @@ -2470,7 +2470,7 @@

Finite Extensions
-inverse()[source]
+inverse()[source]

Multiplicative inverse.

Raises:
diff --git a/dev/modules/polys/domainmatrix.html b/dev/modules/polys/domainmatrix.html index 59c242dcffa..5a8649b5a49 100644 --- a/dev/modules/polys/domainmatrix.html +++ b/dev/modules/polys/domainmatrix.html @@ -836,7 +836,7 @@

What is domainmatrix?
-sympy.polys.matrices.domainmatrix.DM(rows, domain)[source]
+sympy.polys.matrices.domainmatrix.DM(rows, domain)[source]

Convenient alias for DomainMatrix.from_list

Examples

>>> from sympy import ZZ
@@ -853,7 +853,7 @@ 

What is domainmatrix?
-class sympy.polys.matrices.domainmatrix.DomainMatrix(rows, shape, domain, *, fmt=None)[source]
+class sympy.polys.matrices.domainmatrix.DomainMatrix(rows, shape, domain, *, fmt=None)[source]

Associate Matrix with Domain

Explanation

DomainMatrix uses Domain for its internal representation @@ -890,7 +890,7 @@

What is domainmatrix?
-add(B)[source]
+add(B)[source]

Adds two DomainMatrix matrices of the same Domain

Parameters:
@@ -939,7 +939,7 @@

What is domainmatrix?
-adj_det()[source]
+adj_det()[source]

Adjugate and determinant of a square DomainMatrix.

Returns:
@@ -977,7 +977,7 @@

What is domainmatrix?
-adj_poly_det(cp=None)[source]
+adj_poly_det(cp=None)[source]

Return the polynomial \(p\) such that \(p(A) = adj(A)\) and also the determinant of \(A\).

Examples

@@ -1006,7 +1006,7 @@

What is domainmatrix?
-adjugate()[source]
+adjugate()[source]

Adjugate of a square DomainMatrix.

The adjugate matrix is the transpose of the cofactor matrix and is related to the inverse by:

@@ -1039,7 +1039,7 @@

What is domainmatrix?
-cancel_denom(denom)[source]
+cancel_denom(denom)[source]

Cancel factors between a matrix and a denominator.

Returns a matrix and denominator on lowest terms.

Requires gcd in the ground domain.

@@ -1107,7 +1107,7 @@

What is domainmatrix?
-cancel_denom_elementwise(denom)[source]
+cancel_denom_elementwise(denom)[source]

Cancel factors between the elements of a matrix and a denominator.

Returns a matrix of numerators and matrix of denominators.

Requires gcd in the ground domain.

@@ -1146,7 +1146,7 @@

What is domainmatrix?
-charpoly()[source]
+charpoly()[source]

Characteristic polynomial of a square matrix.

Computes the characteristic polynomial in a fully expanded form using division free arithmetic. If a factorization of the characteristic @@ -1186,7 +1186,7 @@

What is domainmatrix?
-charpoly_base()[source]
+charpoly_base()[source]

Base case for charpoly_factor_blocks() after block decomposition.

This method is used internally by charpoly_factor_blocks() as the base case for computing the characteristic polynomial of a block. It is @@ -1204,7 +1204,7 @@

What is domainmatrix?
-charpoly_berk()[source]
+charpoly_berk()[source]

Compute the characteristic polynomial using the Berkowitz algorithm.

This method directly calls the underlying implementation of the Berkowitz algorithm (sympy.polys.matrices.dense.ddm_berk() or @@ -1235,7 +1235,7 @@

What is domainmatrix?
-charpoly_factor_blocks()[source]
+charpoly_factor_blocks()[source]

Partial factorisation of the characteristic polynomial.

This factorisation arises from a block structure of the matrix (if any) and so the factors are not guaranteed to be irreducible. The @@ -1296,7 +1296,7 @@

What is domainmatrix?
-charpoly_factor_list()[source]
+charpoly_factor_list()[source]

Full factorization of the characteristic polynomial.

Returns:
@@ -1345,7 +1345,7 @@

What is domainmatrix?
-choose_domain(**opts)[source]
+choose_domain(**opts)[source]

Convert to a domain found by construct_domain().

Examples

>>> from sympy import ZZ
@@ -1372,7 +1372,7 @@ 

What is domainmatrix?
-clear_denoms(convert=False)[source]
+clear_denoms(convert=False)[source]

Clear denominators, but keep the domain unchanged.

Examples

>>> from sympy import QQ
@@ -1412,7 +1412,7 @@ 

What is domainmatrix?
-clear_denoms_rowwise(convert=False)[source]
+clear_denoms_rowwise(convert=False)[source]

Clear denominators from each row of the matrix.

Examples

>>> from sympy import QQ
@@ -1458,7 +1458,7 @@ 

What is domainmatrix?
-columnspace()[source]
+columnspace()[source]

Returns the columnspace for the DomainMatrix

Returns:
@@ -1482,7 +1482,7 @@

What is domainmatrix?
-content()[source]
+content()[source]

Return the gcd of the elements of the matrix.

Requires gcd in the ground domain.

Examples

@@ -1501,7 +1501,7 @@

What is domainmatrix?
-convert_to(K)[source]
+convert_to(K)[source]

Change the domain of DomainMatrix to desired domain or field

Parameters:
@@ -1534,7 +1534,7 @@

What is domainmatrix?
-det()[source]
+det()[source]

Returns the determinant of a square DomainMatrix.

Returns:
@@ -1566,7 +1566,7 @@

What is domainmatrix?
-classmethod diag(diagonal, domain, shape=None)[source]
+classmethod diag(diagonal, domain, shape=None)[source]

Return diagonal matrix with entries from diagonal.

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -1579,7 +1579,7 @@ 

What is domainmatrix?
-diagonal()[source]
+diagonal()[source]

Get the diagonal entries of the matrix as a list.

Examples

>>> from sympy import ZZ
@@ -1597,7 +1597,7 @@ 

What is domainmatrix?
-eval_poly(p)[source]
+eval_poly(p)[source]

Evaluate polynomial function of a matrix \(p(A)\).

Examples

>>> from sympy import QQ
@@ -1619,7 +1619,7 @@ 

What is domainmatrix?
-eval_poly_mul(p, B)[source]
+eval_poly_mul(p, B)[source]

Evaluate polynomial matrix product \(p(A) \times B\).

Evaluate the polynomial matrix product \(p(A) \times B\) using Horner’s method without creating the matrix \(p(A)\) explicitly. If \(B\) is a @@ -1651,7 +1651,7 @@

What is domainmatrix?
-classmethod eye(shape, domain)[source]
+classmethod eye(shape, domain)[source]

Return identity matrix of size n or shape (m, n).

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -1672,7 +1672,7 @@ 

What is domainmatrix?**kwargs,

-)[source] +)[source]

Convert Matrix to DomainMatrix

Parameters:
@@ -1716,7 +1716,7 @@

What is domainmatrix?**kwargs,

-)[source] +)[source]
Parameters:

nrows: number of rows

@@ -1744,7 +1744,7 @@

What is domainmatrix?
-classmethod from_dod(dod, shape, domain)[source]
+classmethod from_dod(dod, shape, domain)[source]

Create sparse DomainMatrix from dict of dict (dod) format.

See to_dod() for explanation.

@@ -1755,7 +1755,7 @@

What is domainmatrix?
-from_dod_like(dod, domain=None)[source]
+from_dod_like(dod, domain=None)[source]

Create DomainMatrix like self from dict of dict (dod) format.

See to_dod() for explanation.

@@ -1766,7 +1766,7 @@

What is domainmatrix?
-classmethod from_dok(dok, shape, domain)[source]
+classmethod from_dok(dok, shape, domain)[source]

Create DomainMatrix from dictionary of keys (dok) format.

See to_dok() for explanation.

@@ -1777,7 +1777,7 @@

What is domainmatrix?
-from_flat_nz(elements, data, domain)[source]
+from_flat_nz(elements, data, domain)[source]

Reconstruct DomainMatrix after calling to_flat_nz().

See to_flat_nz() for explanation.

@@ -1788,7 +1788,7 @@

What is domainmatrix?
-classmethod from_list(rows, domain)[source]
+classmethod from_list(rows, domain)[source]

Convert a list of lists into a DomainMatrix

Parameters:
@@ -1833,7 +1833,7 @@

What is domainmatrix?domain,

-)[source] +)[source]

Create DomainMatrix from flat list.

Examples

>>> from sympy import ZZ
@@ -1863,7 +1863,7 @@ 

What is domainmatrix?**kwargs,

-)[source] +)[source]

Convert a list of lists of Expr into a DomainMatrix using construct_domain

Parameters:
@@ -1891,7 +1891,7 @@

What is domainmatrix?
-classmethod from_rep(rep)[source]
+classmethod from_rep(rep)[source]

Create a new DomainMatrix efficiently from DDM/SDM.

Parameters:
@@ -1939,7 +1939,7 @@

What is domainmatrix?
-hstack(*B)[source]
+hstack(*B)[source]

Horizontally stack the given matrices.

Parameters:
@@ -1979,7 +1979,7 @@

What is domainmatrix?
-inv()[source]
+inv()[source]

Finds the inverse of the DomainMatrix if exists

Returns:
@@ -2018,7 +2018,7 @@

What is domainmatrix?
-inv_den(method=None)[source]
+inv_den(method=None)[source]

Return the inverse as a DomainMatrix with denominator.

Parameters:
@@ -2112,7 +2112,7 @@

What is domainmatrix?
-iter_items()[source]
+iter_items()[source]

Iterate over indices and values of nonzero elements of the matrix.

Examples

>>> from sympy import ZZ
@@ -2130,7 +2130,7 @@ 

What is domainmatrix?
-iter_values()[source]
+iter_values()[source]

Iterate over nonzero elements of the matrix.

Examples

>>> from sympy import ZZ
@@ -2148,7 +2148,7 @@ 

What is domainmatrix?
-lll(delta=MPQ(3, 4))[source]
+lll(delta=MPQ(3, 4))[source]

Performs the Lenstra–Lenstra–Lovász (LLL) basis reduction algorithm. See [R780] and [R781].

@@ -2213,7 +2213,7 @@

What is domainmatrix?
-lll_transform(delta=MPQ(3, 4))[source]
+lll_transform(delta=MPQ(3, 4))[source]

Performs the Lenstra–Lenstra–Lovász (LLL) basis reduction algorithm and returns the reduced basis and transformation matrix.

Explanation

@@ -2242,7 +2242,7 @@

What is domainmatrix?
-lu()[source]
+lu()[source]

Returns Lower and Upper decomposition of the DomainMatrix

Returns:
@@ -2283,7 +2283,7 @@

What is domainmatrix?
-lu_solve(rhs)[source]
+lu_solve(rhs)[source]

Solver for DomainMatrix x in the A*x = B

Parameters:
@@ -2329,7 +2329,7 @@

What is domainmatrix?
-matmul(B)[source]
+matmul(B)[source]

Performs matrix multiplication of two DomainMatrix matrices

Parameters:
@@ -2368,7 +2368,7 @@

What is domainmatrix?
-mul(b)[source]
+mul(b)[source]

Performs term by term multiplication for the second DomainMatrix w.r.t first DomainMatrix. Returns a DomainMatrix whose rows are list of DomainMatrix matrices created after term by term multiplication.

@@ -2407,7 +2407,7 @@

What is domainmatrix?
-neg()[source]
+neg()[source]

Returns the negative of DomainMatrix

Parameters:
@@ -2436,7 +2436,7 @@

What is domainmatrix?
-nnz()[source]
+nnz()[source]

Number of nonzero elements in the matrix.

Examples

>>> from sympy import ZZ
@@ -2450,7 +2450,7 @@ 

What is domainmatrix?
-nullspace(divide_last=False)[source]
+nullspace(divide_last=False)[source]

Returns the nullspace for the DomainMatrix

Parameters:
@@ -2542,7 +2542,7 @@

What is domainmatrix?
-nullspace_from_rref(pivots=None)[source]
+nullspace_from_rref(pivots=None)[source]

Compute nullspace from rref and pivots.

The domain of the matrix can be any domain.

The matrix must be in reduced row echelon form already. Otherwise the @@ -2556,7 +2556,7 @@

What is domainmatrix?
-classmethod ones(shape, domain)[source]
+classmethod ones(shape, domain)[source]

Returns a DomainMatrix of 1s, of size shape, belonging to the specified domain

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -2569,7 +2569,7 @@ 

What is domainmatrix?
-pow(n)[source]
+pow(n)[source]

Computes A**n

Parameters:
@@ -2609,7 +2609,7 @@

What is domainmatrix?
-primitive()[source]
+primitive()[source]

Factor out gcd of the elements of a matrix.

Requires gcd in the ground domain.

Examples

@@ -2635,7 +2635,7 @@

What is domainmatrix?
-rowspace()[source]
+rowspace()[source]

Returns the rowspace for the DomainMatrix

Returns:
@@ -2659,7 +2659,7 @@

What is domainmatrix?
-rref(*, method='auto')[source]
+rref(*, method='auto')[source]

Returns reduced-row echelon form (RREF) and list of pivots.

If the domain is not a field then it will be converted to a field. See rref_den() for the fraction-free version of this routine that @@ -2754,7 +2754,7 @@

What is domainmatrix?keep_domain=True,

-)[source] +)[source]

Returns reduced-row echelon form with denominator and list of pivots.

Requires exact division in the ground domain (exquo).

@@ -2859,7 +2859,7 @@

What is domainmatrix?
-scc()[source]
+scc()[source]

Compute the strongly connected components of a DomainMatrix

Returns:
@@ -2927,7 +2927,7 @@

What is domainmatrix?
-solve_den(b, method=None)[source]
+solve_den(b, method=None)[source]

Solve matrix equation \(Ax = b\) without fractions in the ground domain.

Parameters:
@@ -3061,7 +3061,7 @@

What is domainmatrix?check=True,

-)[source] +)[source]

Solve matrix equation \(Ax = b\) using the characteristic polynomial.

This method solves the square matrix equation \(Ax = b\) for \(x\) using the characteristic polynomial without any division or fractions in the @@ -3132,7 +3132,7 @@

What is domainmatrix?
-solve_den_rref(b)[source]
+solve_den_rref(b)[source]

Solve matrix equation \(Ax = b\) using fraction-free RREF

Solves the matrix equation \(Ax = b\) for \(x\) and returns the solution as a numerator/denominator pair.

@@ -3158,7 +3158,7 @@

What is domainmatrix?
-sub(B)[source]
+sub(B)[source]

Subtracts two DomainMatrix matrices of the same Domain

Parameters:
@@ -3207,7 +3207,7 @@

What is domainmatrix?
-to_Matrix()[source]
+to_Matrix()[source]

Convert DomainMatrix to Matrix

Returns:
@@ -3239,7 +3239,7 @@

What is domainmatrix?
-to_ddm()[source]
+to_ddm()[source]

Return a DDM representation of self.

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -3260,7 +3260,7 @@ 

What is domainmatrix?
-to_dense()[source]
+to_dense()[source]

Return a dense DomainMatrix representation of self.

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -3277,7 +3277,7 @@ 

What is domainmatrix?
-to_dfm()[source]
+to_dfm()[source]

Return a DFM representation of self.

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -3298,7 +3298,7 @@ 

What is domainmatrix?
-to_dfm_or_ddm()[source]
+to_dfm_or_ddm()[source]

Return a DFM or DDM representation of self.

Explanation

The DFM representation can only be used if the ground types @@ -3335,7 +3335,7 @@

What is domainmatrix?
-to_dod()[source]
+to_dod()[source]

Convert DomainMatrix to dictionary of dictionaries (dod) format.

Explanation

Returns a dictionary of dictionaries representing the matrix.

@@ -3359,7 +3359,7 @@

What is domainmatrix?
-to_dok()[source]
+to_dok()[source]

Convert DomainMatrix to dictionary of keys (dok) format.

Examples

>>> from sympy import ZZ
@@ -3385,7 +3385,7 @@ 

What is domainmatrix?
-to_field()[source]
+to_field()[source]

Returns a DomainMatrix with the appropriate field

Returns:
@@ -3411,7 +3411,7 @@

What is domainmatrix?
-to_flat_nz()[source]
+to_flat_nz()[source]

Convert DomainMatrix to list of nonzero elements and data.

Explanation

Returns a tuple (elements, data) where elements is a list of @@ -3454,7 +3454,7 @@

What is domainmatrix?
-to_list()[source]
+to_list()[source]

Convert DomainMatrix to list of lists.

See also

@@ -3464,7 +3464,7 @@

What is domainmatrix?
-to_list_flat()[source]
+to_list_flat()[source]

Convert DomainMatrix to flat list.

Examples

>>> from sympy import ZZ
@@ -3482,7 +3482,7 @@ 

What is domainmatrix?
-to_sdm()[source]
+to_sdm()[source]

Return a SDM representation of self.

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -3503,7 +3503,7 @@ 

What is domainmatrix?
-to_sparse()[source]
+to_sparse()[source]

Return a sparse DomainMatrix representation of self.

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -3520,13 +3520,13 @@ 

What is domainmatrix?
-transpose()[source]
+transpose()[source]

Matrix transpose of self

-unify(*others, fmt=None)[source]
+unify(*others, fmt=None)[source]

Unifies the domains and the format of self and other matrices.

@@ -3579,7 +3579,7 @@

What is domainmatrix?
-vstack(*B)[source]
+vstack(*B)[source]

Vertically stack the given matrices.

Parameters:
@@ -3619,7 +3619,7 @@

What is domainmatrix?
-classmethod zeros(shape, domain, *, fmt='sparse')[source]
+classmethod zeros(shape, domain, *, fmt='sparse')[source]

Returns a zero DomainMatrix of size shape, belonging to the specified domain

Examples

>>> from sympy.polys.matrices import DomainMatrix
@@ -3689,31 +3689,31 @@ 

What is domainmatrix?
-class sympy.polys.matrices.ddm.DDM(rowslist, shape, domain)[source]
+class sympy.polys.matrices.ddm.DDM(rowslist, shape, domain)[source]

Dense matrix based on polys domain elements

This is a list subclass and is a wrapper for a list of lists that supports basic matrix arithmetic +, -, , *.

-add(b)[source]
+add(b)[source]

a + b

-charpoly()[source]
+charpoly()[source]

Coefficients of characteristic polynomial of a

-det()[source]
+det()[source]

Determinant of a

-classmethod diag(values, domain)[source]
+classmethod diag(values, domain)[source]

Returns a square diagonal matrix with values on the diagonal.

Examples

>>> from sympy import ZZ
@@ -3730,13 +3730,13 @@ 

What is domainmatrix?
-diagonal()[source]
+diagonal()[source]

Returns a list of the elements from the diagonal of the matrix.

-classmethod from_dod(dod, shape, domain)[source]
+classmethod from_dod(dod, shape, domain)[source]

Create a DDM from a dictionary of dictionaries (dod) format.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -3755,7 +3755,7 @@ 

What is domainmatrix?
-classmethod from_dok(dok, shape, domain)[source]
+classmethod from_dok(dok, shape, domain)[source]

Create a DDM from a dictionary of keys (dok) format.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -3774,7 +3774,7 @@ 

What is domainmatrix?
-classmethod from_flat_nz(elements, data, domain)[source]
+classmethod from_flat_nz(elements, data, domain)[source]

Reconstruct a DDM after calling to_flat_nz().

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -3795,7 +3795,7 @@ 

What is domainmatrix?
-classmethod from_list(rowslist, shape, domain)[source]
+classmethod from_list(rowslist, shape, domain)[source]

Create a DDM from a list of lists.

Examples

>>> from sympy import ZZ
@@ -3815,7 +3815,7 @@ 

What is domainmatrix?
-classmethod from_list_flat(flat, shape, domain)[source]
+classmethod from_list_flat(flat, shape, domain)[source]

Create a DDM from a flat list of elements.

Examples

>>> from sympy import QQ
@@ -3835,7 +3835,7 @@ 

What is domainmatrix?
-hstack(*B)[source]
+hstack(*B)[source]

Horizontally stacks DDM matrices.

Examples

>>> from sympy import ZZ
@@ -3857,40 +3857,40 @@ 

What is domainmatrix?
-inv()[source]
+inv()[source]

Inverse of a

-is_diagonal()[source]
+is_diagonal()[source]

Says whether this matrix is diagonal. True can be returned even if the matrix is not square.

-is_lower()[source]
+is_lower()[source]

Says whether this matrix is lower-triangular. True can be returned even if the matrix is not square.

-is_upper()[source]
+is_upper()[source]

Says whether this matrix is upper-triangular. True can be returned even if the matrix is not square.

-is_zero_matrix()[source]
+is_zero_matrix()[source]

Says whether this matrix has all zero entries.

-iter_items()[source]
+iter_items()[source]

Iterate over indices and values of nonzero elements of the matrix.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -3908,7 +3908,7 @@ 

What is domainmatrix?
-iter_values()[source]
+iter_values()[source]

Iterater over the non-zero values of the matrix.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -3926,31 +3926,31 @@ 

What is domainmatrix?
-lu()[source]
+lu()[source]

L, U decomposition of a

-lu_solve(b)[source]
+lu_solve(b)[source]

x where a*x = b

-matmul(b)[source]
+matmul(b)[source]

a @ b (matrix product)

-neg()[source]
+neg()[source]

-a

-nnz()[source]
+nnz()[source]

Number of non-zero entries in DDM matrix.

See also

@@ -3960,7 +3960,7 @@

What is domainmatrix?
-nullspace()[source]
+nullspace()[source]

Returns a basis for the nullspace of a.

The domain of the matrix must be a field.

@@ -3971,7 +3971,7 @@

What is domainmatrix?
-nullspace_from_rref(pivots=None)[source]
+nullspace_from_rref(pivots=None)[source]

Compute the nullspace of a matrix from its rref.

The domain of the matrix can be any domain.

Returns a tuple (basis, nonpivots).

@@ -3986,7 +3986,7 @@

What is domainmatrix?
-rref()[source]
+rref()[source]

Reduced-row echelon form of a and list of pivots.

See also

@@ -4001,7 +4001,7 @@

What is domainmatrix?
-rref_den()[source]
+rref_den()[source]

Reduced-row echelon form of a with denominator and list of pivots

See also

@@ -4016,7 +4016,7 @@

What is domainmatrix?
-scc()[source]
+scc()[source]

Strongly connected components of a square matrix a.

Examples

>>> from sympy import ZZ
@@ -4034,13 +4034,13 @@ 

What is domainmatrix?
-sub(b)[source]
+sub(b)[source]

a - b

-to_ddm()[source]
+to_ddm()[source]

Convert to a DDM.

This just returns self but exists to parallel the corresponding method in other matrix types like SDM.

@@ -4052,7 +4052,7 @@

What is domainmatrix?
-to_dfm()[source]
+to_dfm()[source]

Convert to DDM to DFM.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -4072,7 +4072,7 @@ 

What is domainmatrix?
-to_dfm_or_ddm()[source]
+to_dfm_or_ddm()[source]

Convert to DFM if possible or otherwise return self.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -4092,7 +4092,7 @@ 

What is domainmatrix?
-to_dod()[source]
+to_dod()[source]

Convert to a dictionary of dictionaries (dod) format.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -4110,7 +4110,7 @@ 

What is domainmatrix?
-to_dok()[source]
+to_dok()[source]

Convert DDM to dictionary of keys (dok) format.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -4128,7 +4128,7 @@ 

What is domainmatrix?
-to_flat_nz()[source]
+to_flat_nz()[source]

Convert to a flat list of nonzero elements and data.

Explanation

This is used to operate on a list of the elements of a matrix and then @@ -4153,7 +4153,7 @@

What is domainmatrix?
-to_list()[source]
+to_list()[source]

Convert to a list of lists.

Examples

>>> from sympy import QQ
@@ -4171,7 +4171,7 @@ 

What is domainmatrix?
-to_list_flat()[source]
+to_list_flat()[source]

Convert to a flat list of elements.

Examples

>>> from sympy import QQ
@@ -4191,7 +4191,7 @@ 

What is domainmatrix?
-to_sdm()[source]
+to_sdm()[source]

Convert to a SDM.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -4211,7 +4211,7 @@ 

What is domainmatrix?
-vstack(*B)[source]
+vstack(*B)[source]

Vertically stacks DDM matrices.

Examples

>>> from sympy import ZZ
@@ -4280,7 +4280,7 @@ 

What is domainmatrix?
-sympy.polys.matrices.dense.ddm_berk(M, K)[source]
+sympy.polys.matrices.dense.ddm_berk(M, K)[source]

Berkowitz algorithm for computing the characteristic polynomial.

Explanation

The Berkowitz algorithm is a division-free algorithm for computing the @@ -4322,13 +4322,13 @@

What is domainmatrix?b: Sequence[Sequence[R]],

-) None[source] +) None[source]

a += b

-sympy.polys.matrices.dense.ddm_idet(a, K)[source]
+sympy.polys.matrices.dense.ddm_idet(a, K)[source]

a <– echelon(a); return det

Explanation

Compute the determinant of \(a\) using the Bareiss fraction-free algorithm. @@ -4371,7 +4371,7 @@

What is domainmatrix?
-sympy.polys.matrices.dense.ddm_iinv(ainv, a, K)[source]
+sympy.polys.matrices.dense.ddm_iinv(ainv, a, K)[source]

ainv <– inv(a)

Compute the inverse of a matrix \(a\) over a field \(K\) using Gauss-Jordan elimination. The result is stored in \(ainv\).

@@ -4401,7 +4401,7 @@

What is domainmatrix?
-sympy.polys.matrices.dense.ddm_ilu(a)[source]
+sympy.polys.matrices.dense.ddm_ilu(a)[source]

a <– LU(a)

Computes the LU decomposition of a matrix in place. Returns a list of row swaps that were performed.

@@ -4446,7 +4446,7 @@

What is domainmatrix?
-sympy.polys.matrices.dense.ddm_ilu_solve(x, L, U, swaps, b)[source]
+sympy.polys.matrices.dense.ddm_ilu_solve(x, L, U, swaps, b)[source]

x <– solve(L*U*x = swaps(b))

Solve a linear system, \(A*x = b\), given an LU factorization of \(A\).

Uses division in the ground domain which must be a field.

@@ -4485,7 +4485,7 @@

What is domainmatrix?
-sympy.polys.matrices.dense.ddm_ilu_split(L, U, K)[source]
+sympy.polys.matrices.dense.ddm_ilu_split(L, U, K)[source]

L, U <– LU(U)

Compute the LU decomposition of a matrix \(L\) in place and store the lower and upper triangular matrices in \(L\) and \(U\), respectively. Returns a list @@ -4521,7 +4521,7 @@

What is domainmatrix?c: Sequence[Sequence[R]],

-) None[source] +) None[source]

a += b @ c

@@ -4534,7 +4534,7 @@

What is domainmatrix?b: R,

-) None[source] +) None[source]

a <– a*b

@@ -4546,7 +4546,7 @@

What is domainmatrix?a: list[list[R]],

-) None[source] +) None[source]

a <– -a

@@ -4559,13 +4559,13 @@

What is domainmatrix?b: R,

-) None[source] +) None[source]

a <– b*a

-sympy.polys.matrices.dense.ddm_irref(a, _partial_pivot=False)[source]
+sympy.polys.matrices.dense.ddm_irref(a, _partial_pivot=False)[source]

In-place reduced row echelon form of a matrix.

Compute the reduced row echelon form of \(a\). Modifies \(a\) in place and returns a list of the pivot columns.

@@ -4614,7 +4614,7 @@

What is domainmatrix?
-sympy.polys.matrices.dense.ddm_irref_den(a, K)[source]
+sympy.polys.matrices.dense.ddm_irref_den(a, K)[source]

a <– rref(a); return (den, pivots)

Compute the fraction-free reduced row echelon form (RREF) of \(a\). Modifies \(a\) in place and returns a tuple containing the denominator of the RREF and @@ -4680,7 +4680,7 @@

What is domainmatrix?b: Sequence[Sequence[R]],

-) None[source] +) None[source]

a -= b

@@ -4692,13 +4692,13 @@

What is domainmatrix?matrix: Sequence[Sequence[T]],

-) list[list[T]][source] +) list[list[T]][source]

matrix transpose

-class sympy.polys.matrices._typing.RingElement(*args, **kwargs)[source]
+class sympy.polys.matrices._typing.RingElement(*args, **kwargs)[source]

A ring element.

Must support +, -, *, ** and -.

@@ -4706,7 +4706,7 @@

What is domainmatrix?Module for the SDM class.

-class sympy.polys.matrices.sdm.SDM(elemsdict, shape, domain)[source]
+class sympy.polys.matrices.sdm.SDM(elemsdict, shape, domain)[source]

Sparse matrix based on polys domain elements

This is a dict subclass and is a wrapper for a dict of dicts that supports basic matrix arithmetic +, -, , *.

@@ -4750,7 +4750,7 @@

What is domainmatrix?
-add(B)[source]
+add(B)[source]

Adds two SDM matrices

Examples

>>> from sympy import ZZ
@@ -4765,7 +4765,7 @@ 

What is domainmatrix?
-charpoly()[source]
+charpoly()[source]

Returns the coefficients of the characteristic polynomial of the SDM matrix. These elements will be domain elements. The domain of the elements will be same as domain of the SDM.

@@ -4790,7 +4790,7 @@

What is domainmatrix?
-convert_to(K)[source]
+convert_to(K)[source]

Converts the Domain of a SDM matrix to K

Examples

>>> from sympy import ZZ, QQ
@@ -4804,7 +4804,7 @@ 

What is domainmatrix?
-copy()[source]
+copy()[source]

Returns the copy of a SDM object

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -4820,7 +4820,7 @@ 

What is domainmatrix?
-det()[source]
+det()[source]

Returns determinant of A

Examples

>>> from sympy import QQ
@@ -4834,13 +4834,13 @@ 

What is domainmatrix?
-diagonal()[source]
+diagonal()[source]

Returns the diagonal of the matrix as a list.

-classmethod eye(shape, domain)[source]
+classmethod eye(shape, domain)[source]

Returns a identity SDM matrix of dimensions size x size, belonging to the specified domain

Examples

@@ -4855,7 +4855,7 @@

What is domainmatrix?
-classmethod from_ddm(ddm)[source]
+classmethod from_ddm(ddm)[source]

Create SDM from a DDM.

Examples

>>> from sympy.polys.matrices.ddm import DDM
@@ -4877,7 +4877,7 @@ 

What is domainmatrix?
-classmethod from_dod(dod, shape, domain)[source]
+classmethod from_dod(dod, shape, domain)[source]

Create SDM from dictionary of dictionaries (dod) format.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -4898,7 +4898,7 @@ 

What is domainmatrix?
-classmethod from_dok(dok, shape, domain)[source]
+classmethod from_dok(dok, shape, domain)[source]

Create SDM from dictionary of keys (dok) format.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -4919,7 +4919,7 @@ 

What is domainmatrix?
-classmethod from_flat_nz(elements, data, domain)[source]
+classmethod from_flat_nz(elements, data, domain)[source]

Reconstruct a SDM after calling to_flat_nz().

See to_flat_nz() for explanation.

@@ -4930,7 +4930,7 @@

What is domainmatrix?
-classmethod from_list(ddm, shape, domain)[source]
+classmethod from_list(ddm, shape, domain)[source]

Create SDM object from a list of lists.

Parameters:
@@ -4968,7 +4968,7 @@

What is domainmatrix?
-classmethod from_list_flat(elements, shape, domain)[source]
+classmethod from_list_flat(elements, shape, domain)[source]

Create SDM from a flat list of elements.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -4988,7 +4988,7 @@ 

What is domainmatrix?
-hstack(*B)[source]
+hstack(*B)[source]

Horizontally stacks SDM matrices.

Examples

>>> from sympy import ZZ
@@ -5010,7 +5010,7 @@ 

What is domainmatrix?
-inv()[source]
+inv()[source]

Returns inverse of a matrix A

Examples

>>> from sympy import QQ
@@ -5024,34 +5024,34 @@ 

What is domainmatrix?
-is_diagonal()[source]
+is_diagonal()[source]

Says whether this matrix is diagonal. True can be returned even if the matrix is not square.

-is_lower()[source]
+is_lower()[source]

Says whether this matrix is lower-triangular. True can be returned even if the matrix is not square.

-is_upper()[source]
+is_upper()[source]

Says whether this matrix is upper-triangular. True can be returned even if the matrix is not square.

-is_zero_matrix()[source]
+is_zero_matrix()[source]

Says whether this matrix has all zero entries.

-iter_items()[source]
+iter_items()[source]

Iterate over indices and values of the nonzero elements.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5069,7 +5069,7 @@ 

What is domainmatrix?
-iter_values()[source]
+iter_values()[source]

Iterate over the nonzero values of a SDM matrix.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5083,19 +5083,19 @@ 

What is domainmatrix?
-lll(delta=MPQ(3, 4))[source]
+lll(delta=MPQ(3, 4))[source]

Returns the LLL-reduced basis for the SDM matrix.

-lll_transform(delta=MPQ(3, 4))[source]
+lll_transform(delta=MPQ(3, 4))[source]

Returns the LLL-reduced basis and transformation matrix.

-lu()[source]
+lu()[source]

Returns LU decomposition for a matrix A

Examples

>>> from sympy import QQ
@@ -5109,7 +5109,7 @@ 

What is domainmatrix?
-lu_solve(b)[source]
+lu_solve(b)[source]

Uses LU decomposition to solve Ax = b,

Examples

>>> from sympy import QQ
@@ -5124,7 +5124,7 @@ 

What is domainmatrix?
-matmul(B)[source]
+matmul(B)[source]

Performs matrix multiplication of two SDM matrices

Parameters:
@@ -5157,7 +5157,7 @@

What is domainmatrix?
-mul(b)[source]
+mul(b)[source]

Multiplies each element of A with a scalar b

Examples

>>> from sympy import ZZ
@@ -5171,7 +5171,7 @@ 

What is domainmatrix?
-neg()[source]
+neg()[source]

Returns the negative of a SDM matrix

Examples

>>> from sympy import ZZ
@@ -5185,7 +5185,7 @@ 

What is domainmatrix?
-classmethod new(sdm, shape, domain)[source]
+classmethod new(sdm, shape, domain)[source]
Parameters:

sdm: A dict of dicts for non-zero elements in SDM

@@ -5209,7 +5209,7 @@

What is domainmatrix?
-nnz()[source]
+nnz()[source]

Number of non-zero elements in the SDM matrix.

Examples

>>> from sympy import ZZ
@@ -5227,7 +5227,7 @@ 

What is domainmatrix?
-nullspace()[source]
+nullspace()[source]

Nullspace of a SDM matrix A.

The domain of the matrix must be a field.

It is better to use the nullspace() method rather @@ -5251,7 +5251,7 @@

What is domainmatrix?
-nullspace_from_rref(pivots=None)[source]
+nullspace_from_rref(pivots=None)[source]

Returns nullspace for a SDM matrix A in RREF.

The domain of the matrix can be any domain.

The matrix must already be in reduced row echelon form (RREF).

@@ -5284,7 +5284,7 @@

What is domainmatrix?
-rref()[source]
+rref()[source]

Returns reduced-row echelon form and list of pivots for the SDM

Examples

>>> from sympy import QQ
@@ -5298,7 +5298,7 @@ 

What is domainmatrix?
-rref_den()[source]
+rref_den()[source]

Returns reduced-row echelon form (RREF) with denominator and pivots.

Examples

>>> from sympy import QQ
@@ -5312,7 +5312,7 @@ 

What is domainmatrix?
-scc()[source]
+scc()[source]

Strongly connected components of a square matrix A.

Examples

>>> from sympy import ZZ
@@ -5330,7 +5330,7 @@ 

What is domainmatrix?
-sub(B)[source]
+sub(B)[source]

Subtracts two SDM matrices

Examples

>>> from sympy import ZZ
@@ -5345,7 +5345,7 @@ 

What is domainmatrix?
-to_ddm()[source]
+to_ddm()[source]

Convert a SDM object to a DDM object

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5359,7 +5359,7 @@ 

What is domainmatrix?
-to_dfm()[source]
+to_dfm()[source]

Convert a SDM object to a DFM object

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5377,7 +5377,7 @@ 

What is domainmatrix?
-to_dfm_or_ddm()[source]
+to_dfm_or_ddm()[source]

Convert to DFM if possible, else DDM.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5397,7 +5397,7 @@ 

What is domainmatrix?
-to_dod()[source]
+to_dod()[source]

Convert to dictionary of dictionaries (dod) format.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5415,7 +5415,7 @@ 

What is domainmatrix?
-to_dok()[source]
+to_dok()[source]

Convert to dictionary of keys (dok) format.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5433,7 +5433,7 @@ 

What is domainmatrix?
-to_flat_nz()[source]
+to_flat_nz()[source]

Convert SDM to a flat list of nonzero elements and data.

Explanation

This is used to operate on a list of the elements of a matrix and then @@ -5458,7 +5458,7 @@

What is domainmatrix?
-to_list()[source]
+to_list()[source]

Convert a SDM object to a list of lists.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5473,7 +5473,7 @@ 

What is domainmatrix?
-to_list_flat()[source]
+to_list_flat()[source]

Convert SDM to a flat list.

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5493,13 +5493,13 @@ 

What is domainmatrix?
-to_sdm()[source]
+to_sdm()[source]

Convert to SDM format (returns self).

-transpose()[source]
+transpose()[source]

Returns the transpose of a SDM matrix

Examples

>>> from sympy.polys.matrices.sdm import SDM
@@ -5513,7 +5513,7 @@ 

What is domainmatrix?
-vstack(*B)[source]
+vstack(*B)[source]

Vertically stacks SDM matrices.

Examples

>>> from sympy import ZZ
@@ -5535,7 +5535,7 @@ 

What is domainmatrix?
-classmethod zeros(shape, domain)[source]
+classmethod zeros(shape, domain)[source]

Returns a SDM of size shape, belonging to the specified domain

In the example below we declare a matrix A where,

@@ -5558,7 +5558,7 @@

What is domainmatrix?
-sympy.polys.matrices.sdm.sdm_berk(M, n, K)[source]
+sympy.polys.matrices.sdm.sdm_berk(M, n, K)[source]

Berkowitz algorithm for computing the characteristic polynomial.

Explanation

The Berkowitz algorithm is a division-free algorithm for computing the @@ -5596,7 +5596,7 @@

What is domainmatrix?
-sympy.polys.matrices.sdm.sdm_irref(A)[source]
+sympy.polys.matrices.sdm.sdm_irref(A)[source]

RREF and pivots of a sparse matrix A.

Compute the reduced row echelon form (RREF) of the matrix A and return a list of the pivot columns. This routine does not work in place and leaves @@ -5663,19 +5663,19 @@

What is domainmatrix?nonzero_cols,

-)[source] +)[source]

Get nullspace from A which is in RREF

-sympy.polys.matrices.sdm.sdm_particular_from_rref(A, ncols, pivots)[source]
+sympy.polys.matrices.sdm.sdm_particular_from_rref(A, ncols, pivots)[source]

Get a particular solution from A which is in RREF

-sympy.polys.matrices.sdm.sdm_rref_den(A, K)[source]
+sympy.polys.matrices.sdm.sdm_rref_den(A, K)[source]

Return the reduced row echelon form (RREF) of A with denominator.

The RREF is computed using fraction-free Gauss-Jordan elimination.

Explanation

@@ -5729,7 +5729,7 @@

What is domainmatrix?
-class sympy.polys.matrices._dfm.DFM(rowslist, shape, domain)[source]
+class sympy.polys.matrices._dfm.DFM(rowslist, shape, domain)[source]

Dense FLINT matrix. This class is a wrapper for matrices from python-flint.

>>> from sympy.polys.domains import ZZ
 >>> from sympy.polys.matrices.dfm import DFM
@@ -5763,19 +5763,19 @@ 

What is domainmatrix?
-add(other)[source]
+add(other)[source]

Add two DFM matrices.

-applyfunc(func, domain)[source]
+applyfunc(func, domain)[source]

Apply a function to each entry of a DFM matrix.

-charpoly()[source]
+charpoly()[source]

Compute the characteristic polynomial of the matrix using FLINT.

Examples

>>> from sympy import Matrix
@@ -5810,19 +5810,19 @@ 

What is domainmatrix?
-convert_to(domain)[source]
+convert_to(domain)[source]

Convert to a new domain.

-copy()[source]
+copy()[source]

Return a copy of self.

-det()[source]
+det()[source]

Compute the determinant of the matrix using FLINT.

Examples

>>> from sympy import Matrix
@@ -5863,85 +5863,85 @@ 

What is domainmatrix?
-classmethod diag(elements, domain)[source]
+classmethod diag(elements, domain)[source]

Return a diagonal matrix.

-diagonal()[source]
+diagonal()[source]

Return the diagonal of a DFM matrix.

-extract(rowslist, colslist)[source]
+extract(rowslist, colslist)[source]

Extract a submatrix.

-extract_slice(rowslice, colslice)[source]
+extract_slice(rowslice, colslice)[source]

Slice a DFM.

-classmethod eye(n, domain)[source]
+classmethod eye(n, domain)[source]

Return the identity matrix of size n.

-classmethod from_ddm(ddm)[source]
+classmethod from_ddm(ddm)[source]

Convert from a DDM.

-classmethod from_dod(dod, shape, domain)[source]
+classmethod from_dod(dod, shape, domain)[source]

Inverse of to_dod().

-classmethod from_dok(dok, shape, domain)[source]
+classmethod from_dok(dok, shape, domain)[source]

Inverse of \(to_dod\).

-classmethod from_flat_nz(elements, data, domain)[source]
+classmethod from_flat_nz(elements, data, domain)[source]

Inverse of to_flat_nz().

-classmethod from_list(rowslist, shape, domain)[source]
+classmethod from_list(rowslist, shape, domain)[source]

Construct from a nested list.

-classmethod from_list_flat(elements, shape, domain)[source]
+classmethod from_list_flat(elements, shape, domain)[source]

Inverse of to_list_flat().

-getitem(i, j)[source]
+getitem(i, j)[source]

Get the (i, j)-th entry.

-hstack(*others)[source]
+hstack(*others)[source]

Horizontally stack matrices.

-inv()[source]
+inv()[source]

Compute the inverse of a matrix using FLINT.

Examples

>>> from sympy import Matrix, QQ
@@ -5977,43 +5977,43 @@ 

What is domainmatrix?
-is_diagonal()[source]
+is_diagonal()[source]

Return True if the matrix is diagonal.

-is_lower()[source]
+is_lower()[source]

Return True if the matrix is lower triangular.

-is_upper()[source]
+is_upper()[source]

Return True if the matrix is upper triangular.

-is_zero_matrix()[source]
+is_zero_matrix()[source]

Return True if the matrix is the zero matrix.

-iter_items()[source]
+iter_items()[source]

Iterate over indices and values of nonzero elements of the matrix.

-iter_values()[source]
+iter_values()[source]

Iterater over the non-zero values of the matrix.

-lll(delta=0.75)[source]
+lll(delta=0.75)[source]

Compute LLL-reduced basis using FLINT.

See lll_transform() for more information.

Examples

@@ -6036,7 +6036,7 @@

What is domainmatrix?
-lll_transform(delta=0.75)[source]
+lll_transform(delta=0.75)[source]

Compute LLL-reduced basis and transform using FLINT.

Examples

>>> from sympy import Matrix
@@ -6063,13 +6063,13 @@ 

What is domainmatrix?
-lu()[source]
+lu()[source]

Return the LU decomposition of the matrix.

-lu_solve(rhs)[source]
+lu_solve(rhs)[source]

Solve a matrix equation using FLINT.

Examples

>>> from sympy import Matrix, QQ
@@ -6112,97 +6112,97 @@ 

What is domainmatrix?
-matmul(other)[source]
+matmul(other)[source]

Multiply two DFM matrices.

-mul(other)[source]
+mul(other)[source]

Multiply a DFM matrix from the right by a scalar.

-mul_elementwise(other)[source]
+mul_elementwise(other)[source]

Elementwise multiplication of two DFM matrices.

-neg()[source]
+neg()[source]

Negate a DFM matrix.

-nnz()[source]
+nnz()[source]

Return the number of non-zero elements in the matrix.

-nullspace()[source]
+nullspace()[source]

Return a basis for the nullspace of the matrix.

-nullspace_from_rref(pivots=None)[source]
+nullspace_from_rref(pivots=None)[source]

Return a basis for the nullspace of the matrix.

-classmethod ones(shape, domain)[source]
+classmethod ones(shape, domain)[source]

Return a one DFM matrix.

-particular()[source]
+particular()[source]

Return a particular solution to the system.

-rmul(other)[source]
+rmul(other)[source]

Multiply a DFM matrix from the left by a scalar.

-scc()[source]
+scc()[source]

Return the strongly connected components of the matrix.

-setitem(i, j, value)[source]
+setitem(i, j, value)[source]

Set the (i, j)-th entry.

-sub(other)[source]
+sub(other)[source]

Subtract two DFM matrices.

-to_ddm()[source]
+to_ddm()[source]

Convert to a DDM.

-to_dfm()[source]
+to_dfm()[source]

Return self.

-to_dfm_or_ddm()[source]
+to_dfm_or_ddm()[source]

Convert to a DFM.

This DFM method exists to parallel the DDM and SDM methods. For DFM it will always return self.

@@ -6214,55 +6214,55 @@

What is domainmatrix?
-to_dod()[source]
+to_dod()[source]

Convert to a DOD.

-to_dok()[source]
+to_dok()[source]

Convert to a DOK.

-to_flat_nz()[source]
+to_flat_nz()[source]

Convert to a flat list of non-zeros.

-to_list()[source]
+to_list()[source]

Convert to a nested list.

-to_list_flat()[source]
+to_list_flat()[source]

Convert to a flat list.

-to_sdm()[source]
+to_sdm()[source]

Convert to a SDM.

-transpose()[source]
+transpose()[source]

Transpose a DFM matrix.

-vstack(*others)[source]
+vstack(*others)[source]

Vertically stack matrices.

-classmethod zeros(shape, domain)[source]
+classmethod zeros(shape, domain)[source]

Return a zero DFM matrix.

@@ -6270,7 +6270,7 @@

What is domainmatrix?
-sympy.polys.matrices.normalforms.smith_normal_form(m)[source]
+sympy.polys.matrices.normalforms.smith_normal_form(m)[source]

Return the Smith Normal Form of a matrix \(m\) over the ring \(domain\). This will only work if the ring is a principal ideal domain.

Examples

@@ -6297,7 +6297,7 @@

What is domainmatrix?check_rank=False,

-)[source] +)[source]

Compute the Hermite Normal Form of DomainMatrix A over ZZ.

diff --git a/dev/modules/polys/domainsref.html b/dev/modules/polys/domainsref.html index 99e947bfd6e..90740bad4fc 100644 --- a/dev/modules/polys/domainsref.html +++ b/dev/modules/polys/domainsref.html @@ -830,7 +830,7 @@

Domains

Abstract Domains

-class sympy.polys.domains.domain.Domain[source]
+class sympy.polys.domains.domain.Domain[source]

Superclass for all domains in the polys domains system.

See Introducing the Domains of the poly module for an introductory explanation of the domains system.

@@ -1001,13 +1001,13 @@

Abstract Domains
-abs(a)[source]
+abs(a)[source]

Absolute value of a, implies __abs__.

-add(a, b)[source]
+add(a, b)[source]

Sum of a and b, implies __add__.

@@ -1021,7 +1021,7 @@

Abstract Domainsroot_index=-1,

-)[source] +)[source]

Convenience method to construct an algebraic extension on a root of a polynomial, chosen by root index.

@@ -1064,37 +1064,37 @@

Abstract Domains
-algebraic_field(*extension, alias=None)[source]
+algebraic_field(*extension, alias=None)[source]

Returns an algebraic field, i.e. \(K(\alpha, \ldots)\).

-almosteq(a, b, tolerance=None)[source]
+almosteq(a, b, tolerance=None)[source]

Check if a and b are almost equal.

-characteristic()[source]
+characteristic()[source]

Return the characteristic of this domain.

-cofactors(a, b)[source]
+cofactors(a, b)[source]

Returns GCD and cofactors of a and b.

-convert(element, base=None)[source]
+convert(element, base=None)[source]

Convert element to self.dtype.

-convert_from(element, base)[source]
+convert_from(element, base)[source]

Convert element to self.dtype given the base domain.

@@ -1110,7 +1110,7 @@

Abstract Domainsroot_index=-1,

-)[source] +)[source]

Convenience method to construct a cyclotomic field.

Parameters:
@@ -1156,13 +1156,13 @@

Abstract Domains
-denom(a)[source]
+denom(a)[source]

Returns denominator of a.

-div(a, b)[source]
+div(a, b)[source]

Quotient and remainder for a and b. Analogue of divmod(a, b)

Parameters:
@@ -1244,7 +1244,7 @@

Abstract Domains
-drop(*symbols)[source]
+drop(*symbols)[source]

Drop generators from this domain.

@@ -1274,13 +1274,13 @@

Abstract Domains
-evalf(a, prec=None, **options)[source]
+evalf(a, prec=None, **options)[source]

Returns numerical approximation of a.

-exquo(a, b)[source]
+exquo(a, b)[source]

Exact quotient of a and b. Analogue of a / b.

Parameters:
@@ -1368,7 +1368,7 @@

Abstract Domains
-exsqrt(a)[source]
+exsqrt(a)[source]

Principal square root of a within the domain if a is square.

Explanation

The implementation of this method should return an element b in the @@ -1384,109 +1384,109 @@

Abstract Domains
-frac_field(*symbols, order=LexOrder())[source]
+frac_field(*symbols, order=LexOrder())[source]

Returns a fraction field, i.e. \(K(X)\).

-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert an algebraic number to dtype.

-from_ComplexField(a, K0)[source]
+from_ComplexField(a, K0)[source]

Convert a complex element to dtype.

-from_ExpressionDomain(a, K0)[source]
+from_ExpressionDomain(a, K0)[source]

Convert a EX object to dtype.

-from_ExpressionRawDomain(a, K0)[source]
+from_ExpressionRawDomain(a, K0)[source]

Convert a EX object to dtype.

-from_FF(a, K0)[source]
+from_FF(a, K0)[source]

Convert ModularInteger(int) to dtype.

-from_FF_gmpy(a, K0)[source]
+from_FF_gmpy(a, K0)[source]

Convert ModularInteger(mpz) to dtype.

-from_FF_python(a, K0)[source]
+from_FF_python(a, K0)[source]

Convert ModularInteger(int) to dtype.

-from_FractionField(a, K0)[source]
+from_FractionField(a, K0)[source]

Convert a rational function to dtype.

-from_GlobalPolynomialRing(a, K0)[source]
+from_GlobalPolynomialRing(a, K0)[source]

Convert a polynomial to dtype.

-from_MonogenicFiniteExtension(a, K0)[source]
+from_MonogenicFiniteExtension(a, K0)[source]

Convert an ExtensionElement to dtype.

-from_PolynomialRing(a, K0)[source]
+from_PolynomialRing(a, K0)[source]

Convert a polynomial to dtype.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY mpq object to dtype.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert a real element object to dtype.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY mpz object to dtype.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a Python int object to dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert a SymPy expression to an element of this domain.

Parameters:
@@ -1512,37 +1512,37 @@

Abstract Domains
-gcd(a, b)[source]
+gcd(a, b)[source]

Returns GCD of a and b.

-gcdex(a, b)[source]
+gcdex(a, b)[source]

Extended GCD of a and b.

-get_exact()[source]
+get_exact()[source]

Returns an exact domain associated with self.

-get_field()[source]
+get_field()[source]

Returns a field associated with self.

-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-half_gcdex(a, b)[source]
+half_gcdex(a, b)[source]

Half extended GCD of a and b.

@@ -1584,13 +1584,13 @@

Abstract Domains
-inject(*symbols)[source]
+inject(*symbols)[source]

Inject generators into this domain.

-invert(a, b)[source]
+invert(a, b)[source]

Returns inversion of a mod b, implies something.

@@ -1647,37 +1647,37 @@

Abstract Domains
-is_negative(a)[source]
+is_negative(a)[source]

Returns True if a is negative.

-is_nonnegative(a)[source]
+is_nonnegative(a)[source]

Returns True if a is non-negative.

-is_nonpositive(a)[source]
+is_nonpositive(a)[source]

Returns True if a is non-positive.

-is_one(a)[source]
+is_one(a)[source]

Returns True if a is one.

-is_positive(a)[source]
+is_positive(a)[source]

Returns True if a is positive.

-is_square(a)[source]
+is_square(a)[source]

Returns whether a is a square in the domain.

Explanation

Returns True if there is an element b in the domain such that @@ -1692,67 +1692,67 @@

Abstract Domains
-is_zero(a)[source]
+is_zero(a)[source]

Returns True if a is zero.

-lcm(a, b)[source]
+lcm(a, b)[source]

Returns LCM of a and b.

-log(a, b)[source]
+log(a, b)[source]

Returns b-base logarithm of a.

-map(seq)[source]
+map(seq)[source]

Rersively apply self to all elements of seq.

-mul(a, b)[source]
+mul(a, b)[source]

Product of a and b, implies __mul__.

-n(a, prec=None, **options)[source]
+n(a, prec=None, **options)[source]

Returns numerical approximation of a.

-neg(a)[source]
+neg(a)[source]

Returns a negated, implies __neg__.

-numer(a)[source]
+numer(a)[source]

Returns numerator of a.

-of_type(element)[source]
+of_type(element)[source]

Check if a is of type dtype.

-old_frac_field(*symbols, **kwargs)[source]
+old_frac_field(*symbols, **kwargs)[source]

Returns a fraction field, i.e. \(K(X)\).

-old_poly_ring(*symbols, **kwargs)[source]
+old_poly_ring(*symbols, **kwargs)[source]

Returns a polynomial ring, i.e. \(K[X]\).

@@ -1775,25 +1775,25 @@

Abstract Domains
-poly_ring(*symbols, order=LexOrder())[source]
+poly_ring(*symbols, order=LexOrder())[source]

Returns a polynomial ring, i.e. \(K[X]\).

-pos(a)[source]
+pos(a)[source]

Returns a positive, implies __pos__.

-pow(a, b)[source]
+pow(a, b)[source]

Raise a to power b, implies __pow__.

-quo(a, b)[source]
+quo(a, b)[source]

Quotient of a and b. Analogue of a // b.

K.quo(a, b) is equivalent to K.div(a, b)[0]. See div() for more explanation.

@@ -1812,7 +1812,7 @@

Abstract Domains
-rem(a, b)[source]
+rem(a, b)[source]

Modulo division of a and b. Analogue of a % b.

K.rem(a, b) is equivalent to K.div(a, b)[1]. See div() for more explanation.

@@ -1831,13 +1831,13 @@

Abstract Domains
-revert(a)[source]
+revert(a)[source]

Returns a**(-1) if possible.

-sqrt(a)[source]
+sqrt(a)[source]

Returns a (possibly inexact) square root of a.

Explanation

There is no universal definition of “inexact square root” for all @@ -1851,13 +1851,13 @@

Abstract Domains
-sub(a, b)[source]
+sub(a, b)[source]

Difference of a and b, implies __sub__.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert domain element a to a SymPy expression (Expr).

Parameters:
@@ -1952,7 +1952,7 @@

Abstract Domains
-unify(K1, symbols=None)[source]
+unify(K1, symbols=None)[source]

Construct a minimal domain that contains elements of K0 and K1.

Known domains (from smallest to largest):

@@ -1995,13 +1995,13 @@

Abstract Domains
-class sympy.polys.domains.domainelement.DomainElement[source]
+class sympy.polys.domains.domainelement.DomainElement[source]

Represents an element of a domain.

Mix in this trait into a class whose instances should be recognized as elements of a domain. Method parent() gives that domain.

-parent()[source]
+parent()[source]

Get the domain associated with self

Examples

>>> from sympy import ZZ, symbols
@@ -2023,23 +2023,23 @@ 

Abstract Domains
-class sympy.polys.domains.field.Field[source]
+class sympy.polys.domains.field.Field[source]

Represents a field domain.

-div(a, b)[source]
+div(a, b)[source]

Division of a and b, implies __truediv__.

-exquo(a, b)[source]
+exquo(a, b)[source]

Exact quotient of a and b, implies __truediv__.

-gcd(a, b)[source]
+gcd(a, b)[source]

Returns GCD of a and b.

This definition of GCD over fields allows to clear denominators in \(primitive()\).

@@ -2061,31 +2061,31 @@

Abstract Domains
-gcdex(a, b)[source]
+gcdex(a, b)[source]

Returns x, y, g such that a * x + b * y == g == gcd(a, b)

-get_field()[source]
+get_field()[source]

Returns a field associated with self.

-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-is_unit(a)[source]
+is_unit(a)[source]

Return true if a is a invertible

-lcm(a, b)[source]
+lcm(a, b)[source]

Returns LCM of a and b.

>>> from sympy.polys.domains import QQ
 >>> from sympy import S, lcm
@@ -2101,19 +2101,19 @@ 

Abstract Domains
-quo(a, b)[source]
+quo(a, b)[source]

Quotient of a and b, implies __truediv__.

-rem(a, b)[source]
+rem(a, b)[source]

Remainder of a and b, implies nothing.

-revert(a)[source]
+revert(a)[source]

Returns a**(-1) if possible.

@@ -2121,29 +2121,29 @@

Abstract Domains
-class sympy.polys.domains.ring.Ring[source]
+class sympy.polys.domains.ring.Ring[source]

Represents a ring domain.

-denom(a)[source]
+denom(a)[source]

Returns denominator of \(a\).

-div(a, b)[source]
+div(a, b)[source]

Division of a and b, implies __divmod__.

-exquo(a, b)[source]
+exquo(a, b)[source]

Exact quotient of a and b, implies __floordiv__.

-free_module(rank)[source]
+free_module(rank)[source]

Generate a free module of rank rank over self.

>>> from sympy.abc import x
 >>> from sympy import QQ
@@ -2155,13 +2155,13 @@ 

Abstract Domains
-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-ideal(*gens)[source]
+ideal(*gens)[source]

Generate an ideal of self.

>>> from sympy.abc import x
 >>> from sympy import QQ
@@ -2173,25 +2173,25 @@ 

Abstract Domains
-invert(a, b)[source]
+invert(a, b)[source]

Returns inversion of a mod b.

-numer(a)[source]
+numer(a)[source]

Returns numerator of a.

-quo(a, b)[source]
+quo(a, b)[source]

Quotient of a and b, implies __floordiv__.

-quotient_ring(e)[source]
+quotient_ring(e)[source]

Form a quotient ring of self.

Here e can be an ideal or an iterable.

>>> from sympy.abc import x
@@ -2211,13 +2211,13 @@ 

Abstract Domains
-rem(a, b)[source]
+rem(a, b)[source]

Remainder of a and b, implies __mod__.

-revert(a)[source]
+revert(a)[source]

Returns a**(-1) if possible.

@@ -2225,11 +2225,11 @@

Abstract Domains
-class sympy.polys.domains.simpledomain.SimpleDomain[source]
+class sympy.polys.domains.simpledomain.SimpleDomain[source]

Base class for simple domains, e.g. ZZ, QQ.

-inject(*gens)[source]
+inject(*gens)[source]

Inject generators into this domain.

@@ -2237,23 +2237,23 @@

Abstract Domains
-class sympy.polys.domains.compositedomain.CompositeDomain[source]
+class sympy.polys.domains.compositedomain.CompositeDomain[source]

Base class for composite domains, e.g. ZZ[x], ZZ(X).

-drop(*symbols)[source]
+drop(*symbols)[source]

Drop generators from this domain.

-get_exact()[source]
+get_exact()[source]

Returns an exact version of this domain.

-inject(*symbols)[source]
+inject(*symbols)[source]

Inject generators into this domain.

@@ -2265,7 +2265,7 @@

Abstract Domains
-set_domain(domain)[source]
+set_domain(domain)[source]

Set the ground domain of this domain.

@@ -2276,7 +2276,7 @@

Abstract Domains

GF(p)

-class sympy.polys.domains.FiniteField(mod, symmetric=True)[source]
+class sympy.polys.domains.FiniteField(mod, symmetric=True)[source]

Finite field of prime order GF(p)

A GF(p) domain represents a finite field \(\mathbb{F}_p\) of prime order as Domain in the domain system (see @@ -2359,13 +2359,13 @@

Abstract DomainsGF(p**n)) but these are not yet implemented in SymPY.

-characteristic()[source]
+characteristic()[source]

Return the characteristic of this domain.

-exsqrt(a)[source]
+exsqrt(a)[source]

Square root modulo p of a if it is a quadratic residue.

Explanation

Always returns the square root that is no larger than p // 2.

@@ -2373,115 +2373,115 @@

Abstract Domains
-from_FF(a, K0=None)[source]
+from_FF(a, K0=None)[source]

Convert ModularInteger(int) to dtype.

-from_FF_gmpy(a, K0=None)[source]
+from_FF_gmpy(a, K0=None)[source]

Convert ModularInteger(mpz) to dtype.

-from_FF_python(a, K0=None)[source]
+from_FF_python(a, K0=None)[source]

Convert ModularInteger(int) to dtype.

-from_QQ(a, K0=None)[source]
+from_QQ(a, K0=None)[source]

Convert Python’s Fraction to dtype.

-from_QQ_gmpy(a, K0=None)[source]
+from_QQ_gmpy(a, K0=None)[source]

Convert GMPY’s mpq to dtype.

-from_QQ_python(a, K0=None)[source]
+from_QQ_python(a, K0=None)[source]

Convert Python’s Fraction to dtype.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert mpmath’s mpf to dtype.

-from_ZZ(a, K0=None)[source]
+from_ZZ(a, K0=None)[source]

Convert Python’s int to dtype.

-from_ZZ_gmpy(a, K0=None)[source]
+from_ZZ_gmpy(a, K0=None)[source]

Convert GMPY’s mpz to dtype.

-from_ZZ_python(a, K0=None)[source]
+from_ZZ_python(a, K0=None)[source]

Convert Python’s int to dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s Integer to SymPy’s Integer.

-get_field()[source]
+get_field()[source]

Returns a field associated with self.

-is_negative(a)[source]
+is_negative(a)[source]

Returns True if a is negative.

-is_nonnegative(a)[source]
+is_nonnegative(a)[source]

Returns True if a is non-negative.

-is_nonpositive(a)[source]
+is_nonpositive(a)[source]

Returns True if a is non-positive.

-is_positive(a)[source]
+is_positive(a)[source]

Returns True if a is positive.

-is_square(a)[source]
+is_square(a)[source]

Returns True if a is a quadratic residue modulo p.

-to_int(a)[source]
+to_int(a)[source]

Convert val to a Python int object.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -2489,13 +2489,13 @@

Abstract Domains
-class sympy.polys.domains.PythonFiniteField(mod, symmetric=True)[source]
+class sympy.polys.domains.PythonFiniteField(mod, symmetric=True)[source]

Finite field based on Python’s integers.

-class sympy.polys.domains.GMPYFiniteField(mod, symmetric=True)[source]
+class sympy.polys.domains.GMPYFiniteField(mod, symmetric=True)[source]

Finite field based on GMPY integers.

@@ -2551,7 +2551,7 @@

Abstract Domains
-class sympy.polys.domains.IntegerRing[source]
+class sympy.polys.domains.IntegerRing[source]

The domain ZZ representing the integers \(\mathbb{Z}\).

The IntegerRing class represents the ring of integers as a Domain in the domain system. IntegerRing is a @@ -2571,7 +2571,7 @@

Abstract Domainsalias=None,

-)[source] +)[source]

Returns an algebraic field, i.e. \(\mathbb{Q}(\alpha, \ldots)\).

Parameters:
@@ -2603,7 +2603,7 @@

Abstract Domains
-exsqrt(a)[source]
+exsqrt(a)[source]

Non-negative square root of a if a is a square.

See also

@@ -2613,104 +2613,104 @@

Abstract Domains
-factorial(a)[source]
+factorial(a)[source]

Compute factorial of a.

-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert a ANP object to ZZ.

See convert().

-from_EX(a, K0)[source]
+from_EX(a, K0)[source]

Convert Expression to GMPY’s mpz.

-from_FF(a, K0)[source]
+from_FF(a, K0)[source]

Convert ModularInteger(int) to GMPY’s mpz.

-from_FF_gmpy(a, K0)[source]
+from_FF_gmpy(a, K0)[source]

Convert ModularInteger(mpz) to GMPY’s mpz.

-from_FF_python(a, K0)[source]
+from_FF_python(a, K0)[source]

Convert ModularInteger(int) to GMPY’s mpz.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert Python’s Fraction to GMPY’s mpz.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert GMPY mpq to GMPY’s mpz.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert Python’s Fraction to GMPY’s mpz.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert mpmath’s mpf to GMPY’s mpz.

-from_ZZ(a, K0)[source]
+from_ZZ(a, K0)[source]

Convert Python’s int to GMPY’s mpz.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert GMPY’s mpz to GMPY’s mpz.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert Python’s int to GMPY’s mpz.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s Integer to dtype.

-gcd(a, b)[source]
+gcd(a, b)[source]

Compute GCD of a and b.

-gcdex(a, b)[source]
+gcdex(a, b)[source]

Compute extended GCD of a and b.

-get_field()[source]
+get_field()[source]

Return the associated field of fractions QQ

Returns:
@@ -2732,7 +2732,7 @@

Abstract Domains
-is_square(a)[source]
+is_square(a)[source]

Return True if a is a square.

Explanation

An integer is a square if and only if there exists an integer @@ -2741,13 +2741,13 @@

Abstract Domains
-lcm(a, b)[source]
+lcm(a, b)[source]

Compute LCM of a and b.

-log(a, b)[source]
+log(a, b)[source]

Logarithm of a to the base b.

Parameters:
@@ -2776,13 +2776,13 @@

Abstract Domains
-sqrt(a)[source]
+sqrt(a)[source]

Compute square root of a.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -2790,7 +2790,7 @@

Abstract Domains
-class sympy.polys.domains.PythonIntegerRing[source]
+class sympy.polys.domains.PythonIntegerRing[source]

Integer ring based on Python’s int type.

This will be used as ZZ if gmpy and gmpy2 are not installed. Elements are instances of the standard Python int type.

@@ -2798,97 +2798,97 @@

Abstract Domains
-class sympy.polys.domains.GMPYIntegerRing[source]
+class sympy.polys.domains.GMPYIntegerRing[source]

Integer ring based on GMPY’s mpz type.

This will be the implementation of ZZ if gmpy or gmpy2 is installed. Elements will be of type gmpy.mpz.

-factorial(a)[source]
+factorial(a)[source]

Compute factorial of a.

-from_FF_gmpy(a, K0)[source]
+from_FF_gmpy(a, K0)[source]

Convert ModularInteger(mpz) to GMPY’s mpz.

-from_FF_python(a, K0)[source]
+from_FF_python(a, K0)[source]

Convert ModularInteger(int) to GMPY’s mpz.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert Python’s Fraction to GMPY’s mpz.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert GMPY mpq to GMPY’s mpz.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert Python’s Fraction to GMPY’s mpz.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert mpmath’s mpf to GMPY’s mpz.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert GMPY’s mpz to GMPY’s mpz.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert Python’s int to GMPY’s mpz.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s Integer to dtype.

-gcd(a, b)[source]
+gcd(a, b)[source]

Compute GCD of a and b.

-gcdex(a, b)[source]
+gcdex(a, b)[source]

Compute extended GCD of a and b.

-lcm(a, b)[source]
+lcm(a, b)[source]

Compute LCM of a and b.

-sqrt(a)[source]
+sqrt(a)[source]

Compute square root of a.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -2938,7 +2938,7 @@

Abstract Domains
-class sympy.polys.domains.RationalField[source]
+class sympy.polys.domains.RationalField[source]

Abstract base class for the domain QQ.

The RationalField class represents the field of rational numbers \(\mathbb{Q}\) as a Domain in the domain system. @@ -2959,7 +2959,7 @@

Abstract Domainsalias=None,

-)[source] +)[source]

Returns an algebraic field, i.e. \(\mathbb{Q}(\alpha, \ldots)\).

Parameters:
@@ -2991,25 +2991,25 @@

Abstract Domains
-denom(a)[source]
+denom(a)[source]

Returns denominator of a.

-div(a, b)[source]
+div(a, b)[source]

Division of a and b, implies __truediv__.

-exquo(a, b)[source]
+exquo(a, b)[source]

Exact quotient of a and b, implies __truediv__.

-exsqrt(a)[source]
+exsqrt(a)[source]

Non-negative square root of a if a is a square.

See also

@@ -3019,74 +3019,74 @@

Abstract Domains
-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert a ANP object to QQ.

See convert()

-from_GaussianRationalField(a, K0)[source]
+from_GaussianRationalField(a, K0)[source]

Convert a GaussianElement object to dtype.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY mpq object to dtype.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert a mpmath mpf object to dtype.

-from_ZZ(a, K0)[source]
+from_ZZ(a, K0)[source]

Convert a Python int object to dtype.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY mpz object to dtype.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a Python int object to dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s Integer to dtype.

-get_ring()[source]
+get_ring()[source]

Returns ring associated with self.

-is_square(a)[source]
+is_square(a)[source]

Return True if a is a square.

Explanation

A rational number is a square if and only if there exists @@ -3095,25 +3095,25 @@

Abstract Domains
-numer(a)[source]
+numer(a)[source]

Returns numerator of a.

-quo(a, b)[source]
+quo(a, b)[source]

Quotient of a and b, implies __truediv__.

-rem(a, b)[source]
+rem(a, b)[source]

Remainder of a and b, implies nothing.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -3121,7 +3121,7 @@

Abstract Domains
-class sympy.polys.domains.PythonRationalField[source]
+class sympy.polys.domains.PythonRationalField[source]

Rational field based on MPQ.

This will be used as QQ if gmpy and gmpy2 are not installed. Elements are instances of MPQ.

@@ -3129,31 +3129,31 @@

Abstract Domains
-class sympy.polys.domains.GMPYRationalField[source]
+class sympy.polys.domains.GMPYRationalField[source]

Rational field based on GMPY’s mpq type.

This will be the implementation of QQ if gmpy or gmpy2 is installed. Elements will be of type gmpy.mpq.

-denom(a)[source]
+denom(a)[source]

Returns denominator of a.

-div(a, b)[source]
+div(a, b)[source]

Division of a and b, implies __truediv__.

-exquo(a, b)[source]
+exquo(a, b)[source]

Exact quotient of a and b, implies __truediv__.

-factorial(a)[source]
+factorial(a)[source]

Returns factorial of a.

@@ -3166,73 +3166,73 @@

Abstract DomainsK0,

-)[source] +)[source]

Convert a GaussianElement object to dtype.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY mpq object to dtype.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert a mpmath mpf object to dtype.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY mpz object to dtype.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a Python int object to dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s Integer to dtype.

-get_ring()[source]
+get_ring()[source]

Returns ring associated with self.

-numer(a)[source]
+numer(a)[source]

Returns numerator of a.

-quo(a, b)[source]
+quo(a, b)[source]

Quotient of a and b, implies __truediv__.

-rem(a, b)[source]
+rem(a, b)[source]

Remainder of a and b, implies nothing.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -3240,7 +3240,7 @@

Abstract Domains
-class sympy.external.pythonmpq.PythonMPQ(numerator, denominator=None)[source]
+class sympy.external.pythonmpq.PythonMPQ(numerator, denominator=None)[source]

Rational number implementation that is intended to be compatible with gmpy2’s mpq.

Also slightly faster than fractions.Fraction.

@@ -3261,89 +3261,89 @@

Gaussian domainsGaussianDomain for the domains themselves.

-class sympy.polys.domains.gaussiandomains.GaussianDomain[source]
+class sympy.polys.domains.gaussiandomains.GaussianDomain[source]

Base class for Gaussian domains.

-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert an element from ZZ<I> or QQ<I> to self.dtype.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert a GMPY mpq to self.dtype.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY mpq to self.dtype.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a QQ_python element to self.dtype.

-from_ZZ(a, K0)[source]
+from_ZZ(a, K0)[source]

Convert a ZZ_python element to self.dtype.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY mpz to self.dtype.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a ZZ_python element to self.dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert a SymPy object to self.dtype.

-inject(*gens)[source]
+inject(*gens)[source]

Inject generators into this domain.

-is_negative(element)[source]
+is_negative(element)[source]

Returns False for any GaussianElement.

-is_nonnegative(element)[source]
+is_nonnegative(element)[source]

Returns False for any GaussianElement.

-is_nonpositive(element)[source]
+is_nonpositive(element)[source]

Returns False for any GaussianElement.

-is_positive(element)[source]
+is_positive(element)[source]

Returns False for any GaussianElement.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -3351,23 +3351,23 @@

Gaussian domains
-class sympy.polys.domains.gaussiandomains.GaussianElement(x, y=0)[source]
+class sympy.polys.domains.gaussiandomains.GaussianElement(x, y=0)[source]

Base class for elements of Gaussian type domains.

-classmethod new(x, y)[source]
+classmethod new(x, y)[source]

Create a new GaussianElement of the same domain.

-parent()[source]
+parent()[source]

The domain that this is an element of (ZZ_I or QQ_I)

-quadrant()[source]
+quadrant()[source]

Return quadrant index 0-3.

0 is included in quadrant 0.

@@ -3379,7 +3379,7 @@

Gaussian domains

ZZ_I

-class sympy.polys.domains.gaussiandomains.GaussianIntegerRing[source]
+class sympy.polys.domains.gaussiandomains.GaussianIntegerRing[source]

Ring of Gaussian integers ZZ_I

The ZZ_I domain represents the Gaussian integers \(\mathbb{Z}[i]\) as a Domain in the domain system (see @@ -3475,7 +3475,7 @@

Gaussian domains
-dtype[source]
+dtype[source]

alias of GaussianInteger

@@ -3488,7 +3488,7 @@

Gaussian domainsK0,

-)[source] +)[source]

Convert a ZZ_I element to ZZ_I.

@@ -3501,43 +3501,43 @@

Gaussian domainsK0,

-)[source] +)[source]

Convert a QQ_I element to ZZ_I.

-gcd(a, b)[source]
+gcd(a, b)[source]

Greatest common divisor of a and b over ZZ_I.

-gcdex(a, b)[source]
+gcdex(a, b)[source]

Return x, y, g such that x * a + y * b = g = gcd(a, b)

-get_field()[source]
+get_field()[source]

Returns a field associated with self.

-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-lcm(a, b)[source]
+lcm(a, b)[source]

Least common multiple of a and b over ZZ_I.

-normalize(d, *args)[source]
+normalize(d, *args)[source]

Return first quadrant element associated with d.

Also multiply the other arguments by the same power of i.

@@ -3546,7 +3546,7 @@

Gaussian domains
-class sympy.polys.domains.gaussiandomains.GaussianInteger(x, y=0)[source]
+class sympy.polys.domains.gaussiandomains.GaussianInteger(x, y=0)[source]

Gaussian integer: domain element for ZZ_I

>>> from sympy import ZZ_I
 >>> z = ZZ_I(2, 3)
@@ -3563,7 +3563,7 @@ 

Gaussian domains

QQ_I

-class sympy.polys.domains.gaussiandomains.GaussianRationalField[source]
+class sympy.polys.domains.gaussiandomains.GaussianRationalField[source]

Field of Gaussian rationals QQ_I

The QQ_I domain represents the Gaussian rationals \(\mathbb{Q}(i)\) as a Domain in the domain system (see @@ -3678,25 +3678,25 @@

Gaussian domains
-as_AlgebraicField()[source]
+as_AlgebraicField()[source]

Get equivalent domain as an AlgebraicField.

-denom(a)[source]
+denom(a)[source]

Get the denominator of a.

-dtype[source]
+dtype[source]

alias of GaussianRational

-from_ComplexField(a, K0)[source]
+from_ComplexField(a, K0)[source]

Convert a ComplexField element to QQ_I.

@@ -3709,7 +3709,7 @@

Gaussian domainsK0,

-)[source] +)[source]

Convert a ZZ_I element to QQ_I.

@@ -3722,25 +3722,25 @@

Gaussian domainsK0,

-)[source] +)[source]

Convert a QQ_I element to QQ_I.

-get_field()[source]
+get_field()[source]

Returns a field associated with self.

-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-numer(a)[source]
+numer(a)[source]

Get the numerator of a.

@@ -3748,7 +3748,7 @@

Gaussian domains
-class sympy.polys.domains.gaussiandomains.GaussianRational(x, y=0)[source]
+class sympy.polys.domains.gaussiandomains.GaussianRational(x, y=0)[source]

Gaussian rational: domain element for QQ_I

>>> from sympy import QQ_I, QQ
 >>> z = QQ_I(QQ(2, 3), QQ(4, 5))
@@ -3765,7 +3765,7 @@ 

Gaussian domains

QQ<a>

-class sympy.polys.domains.AlgebraicField(dom, *ext, alias=None)[source]
+class sympy.polys.domains.AlgebraicField(dom, *ext, alias=None)[source]

Algebraic number field QQ<a>

A QQ<a> domain represents an algebraic number field \(\mathbb{Q}(a)\) as a Domain in the domain system (see @@ -3990,25 +3990,25 @@

Gaussian domainsalias=None,

-)[source] +)[source]

Returns an algebraic field, i.e. \(\mathbb{Q}(\alpha, \ldots)\).

-denom(a)[source]
+denom(a)[source]

Returns denominator of a.

-discriminant()[source]
+discriminant()[source]

Get the discriminant of the field.

-dtype[source]
+dtype[source]

alias of ANP

@@ -4026,67 +4026,67 @@

Gaussian domains
-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert AlgebraicField element ‘a’ to another AlgebraicField

-from_GaussianIntegerRing(a, K0)[source]
+from_GaussianIntegerRing(a, K0)[source]

Convert a GaussianInteger element ‘a’ to dtype.

-from_GaussianRationalField(a, K0)[source]
+from_GaussianRationalField(a, K0)[source]

Convert a GaussianRational element ‘a’ to dtype.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY mpq object to dtype.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert a mpmath mpf object to dtype.

-from_ZZ(a, K0)[source]
+from_ZZ(a, K0)[source]

Convert a Python int object to dtype.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY mpz object to dtype.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a Python int object to dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s expression to dtype.

@@ -4100,7 +4100,7 @@

Gaussian domainsrandomize=False,

-)[source] +)[source]

Compute the Galois group of the Galois closure of this field.

Examples

If the field is Galois, the order of the group will equal the degree @@ -4130,13 +4130,13 @@

Gaussian domains
-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-integral_basis(fmt=None)[source]
+integral_basis(fmt=None)[source]

Get an integral basis for the field.

Parameters:
@@ -4181,31 +4181,31 @@

Gaussian domains
-is_negative(a)[source]
+is_negative(a)[source]

Returns True if a is negative.

-is_nonnegative(a)[source]
+is_nonnegative(a)[source]

Returns True if a is non-negative.

-is_nonpositive(a)[source]
+is_nonpositive(a)[source]

Returns True if a is non-positive.

-is_positive(a)[source]
+is_positive(a)[source]

Returns True if a is positive.

-maximal_order()[source]
+maximal_order()[source]

Compute the maximal order, or ring of integers, of the field.

Returns:
@@ -4232,7 +4232,7 @@

Gaussian domains
-numer(a)[source]
+numer(a)[source]

Returns numerator of a.

@@ -4250,19 +4250,19 @@

Gaussian domains
-primes_above(p)[source]
+primes_above(p)[source]

Compute the prime ideals lying above a given rational prime p.

-to_alg_num(a)[source]
+to_alg_num(a)[source]

Convert a of dtype to an AlgebraicNumber.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a of dtype to a SymPy object.

@@ -4273,17 +4273,17 @@

Gaussian domains

RR

-class sympy.polys.domains.RealField(prec=None, dps=None, tol=None)[source]
+class sympy.polys.domains.RealField(prec=None, dps=None, tol=None)[source]

Real numbers up to the given precision.

-almosteq(a, b, tolerance=None)[source]
+almosteq(a, b, tolerance=None)[source]

Check if a and b are almost equal.

-exsqrt(a)[source]
+exsqrt(a)[source]

Non-negative square root for a >= 0 and None otherwise.

Explanation

The square root may be slightly inaccurate due to floating point @@ -4292,49 +4292,49 @@

Gaussian domains
-from_sympy(expr)[source]
+from_sympy(expr)[source]

Convert SymPy’s number to dtype.

-gcd(a, b)[source]
+gcd(a, b)[source]

Returns GCD of a and b.

-get_exact()[source]
+get_exact()[source]

Returns an exact domain associated with self.

-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-is_square(a)[source]
+is_square(a)[source]

Returns True if a >= 0 and False otherwise.

-lcm(a, b)[source]
+lcm(a, b)[source]

Returns LCM of a and b.

-to_rational(element, limit=True)[source]
+to_rational(element, limit=True)[source]

Convert a real number to rational number.

-to_sympy(element)[source]
+to_sympy(element)[source]

Convert element to SymPy number.

@@ -4345,17 +4345,17 @@

Gaussian domains

CC

-class sympy.polys.domains.ComplexField(prec=None, dps=None, tol=None)[source]
+class sympy.polys.domains.ComplexField(prec=None, dps=None, tol=None)[source]

Complex numbers up to the given precision.

-almosteq(a, b, tolerance=None)[source]
+almosteq(a, b, tolerance=None)[source]

Check if a and b are almost equal.

-exsqrt(a)[source]
+exsqrt(a)[source]

Returns the principal complex square root of a.

Explanation

The argument of the principal square root is always within @@ -4365,67 +4365,67 @@

Gaussian domains
-from_sympy(expr)[source]
+from_sympy(expr)[source]

Convert SymPy’s number to dtype.

-gcd(a, b)[source]
+gcd(a, b)[source]

Returns GCD of a and b.

-get_exact()[source]
+get_exact()[source]

Returns an exact domain associated with self.

-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-is_negative(element)[source]
+is_negative(element)[source]

Returns False for any ComplexElement.

-is_nonnegative(element)[source]
+is_nonnegative(element)[source]

Returns False for any ComplexElement.

-is_nonpositive(element)[source]
+is_nonpositive(element)[source]

Returns False for any ComplexElement.

-is_positive(element)[source]
+is_positive(element)[source]

Returns False for any ComplexElement.

-is_square(a)[source]
+is_square(a)[source]

Returns True. Every complex number has a complex square root.

-lcm(a, b)[source]
+lcm(a, b)[source]

Returns LCM of a and b.

-to_sympy(element)[source]
+to_sympy(element)[source]

Convert element to SymPy number.

@@ -4444,161 +4444,161 @@

Gaussian domainsorder=None,

-)[source] +)[source]

A class for representing multivariate polynomial rings.

-factorial(a)[source]
+factorial(a)[source]

Returns factorial of \(a\).

-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert an algebraic number to dtype.

-from_ComplexField(a, K0)[source]
+from_ComplexField(a, K0)[source]

Convert a mpmath \(mpf\) object to \(dtype\).

-from_FractionField(a, K0)[source]
+from_FractionField(a, K0)[source]

Convert a rational function to dtype.

-from_GaussianIntegerRing(a, K0)[source]
+from_GaussianIntegerRing(a, K0)[source]

Convert a \(GaussianInteger\) object to \(dtype\).

-from_GaussianRationalField(a, K0)[source]
+from_GaussianRationalField(a, K0)[source]

Convert a \(GaussianRational\) object to \(dtype\).

-from_GlobalPolynomialRing(a, K0)[source]
+from_GlobalPolynomialRing(a, K0)[source]

Convert from old poly ring to dtype.

-from_PolynomialRing(a, K0)[source]
+from_PolynomialRing(a, K0)[source]

Convert a polynomial to dtype.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert a Python \(Fraction\) object to \(dtype\).

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY \(mpq\) object to \(dtype\).

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a Python \(Fraction\) object to \(dtype\).

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert a mpmath \(mpf\) object to \(dtype\).

-from_ZZ(a, K0)[source]
+from_ZZ(a, K0)[source]

Convert a Python \(int\) object to \(dtype\).

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY \(mpz\) object to \(dtype\).

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a Python \(int\) object to \(dtype\).

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s expression to \(dtype\).

-gcd(a, b)[source]
+gcd(a, b)[source]

Returns GCD of \(a\) and \(b\).

-gcdex(a, b)[source]
+gcdex(a, b)[source]

Extended GCD of \(a\) and \(b\).

-get_field()[source]
+get_field()[source]

Returns a field associated with \(self\).

-is_negative(a)[source]
+is_negative(a)[source]

Returns True if \(LC(a)\) is negative.

-is_nonnegative(a)[source]
+is_nonnegative(a)[source]

Returns True if \(LC(a)\) is non-negative.

-is_nonpositive(a)[source]
+is_nonpositive(a)[source]

Returns True if \(LC(a)\) is non-positive.

-is_positive(a)[source]
+is_positive(a)[source]

Returns True if \(LC(a)\) is positive.

-is_unit(a)[source]
+is_unit(a)[source]

Returns True if a is a unit of self

-lcm(a, b)[source]
+lcm(a, b)[source]

Returns LCM of \(a\) and \(b\).

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert \(a\) to a SymPy object.

@@ -4617,143 +4617,143 @@

Gaussian domainsorder=None,

-)[source] +)[source]

A class for representing multivariate rational function fields.

-denom(a)[source]
+denom(a)[source]

Returns denominator of a.

-factorial(a)[source]
+factorial(a)[source]

Returns factorial of a.

-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert an algebraic number to dtype.

-from_ComplexField(a, K0)[source]
+from_ComplexField(a, K0)[source]

Convert a mpmath mpf object to dtype.

-from_FractionField(a, K0)[source]
+from_FractionField(a, K0)[source]

Convert a rational function to dtype.

-from_GaussianIntegerRing(a, K0)[source]
+from_GaussianIntegerRing(a, K0)[source]

Convert a GaussianInteger object to dtype.

-from_GaussianRationalField(a, K0)[source]
+from_GaussianRationalField(a, K0)[source]

Convert a GaussianRational object to dtype.

-from_PolynomialRing(a, K0)[source]
+from_PolynomialRing(a, K0)[source]

Convert a polynomial to dtype.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY mpq object to dtype.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert a mpmath mpf object to dtype.

-from_ZZ(a, K0)[source]
+from_ZZ(a, K0)[source]

Convert a Python int object to dtype.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY mpz object to dtype.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a Python int object to dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s expression to dtype.

-get_ring()[source]
+get_ring()[source]

Returns a field associated with self.

-is_negative(a)[source]
+is_negative(a)[source]

Returns True if LC(a) is negative.

-is_nonnegative(a)[source]
+is_nonnegative(a)[source]

Returns True if LC(a) is non-negative.

-is_nonpositive(a)[source]
+is_nonpositive(a)[source]

Returns True if LC(a) is non-positive.

-is_positive(a)[source]
+is_positive(a)[source]

Returns True if LC(a) is positive.

-numer(a)[source]
+numer(a)[source]

Returns numerator of a.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -4764,161 +4764,161 @@

Gaussian domains

EX

-class sympy.polys.domains.ExpressionDomain[source]
+class sympy.polys.domains.ExpressionDomain[source]

A class for arbitrary expressions.

-class Expression(ex)[source]
+class Expression(ex)[source]

An arbitrary expression.

-denom(a)[source]
+denom(a)[source]

Returns denominator of a.

-dtype[source]
+dtype[source]

alias of Expression

-from_AlgebraicField(a, K0)[source]
+from_AlgebraicField(a, K0)[source]

Convert an ANP object to dtype.

-from_ComplexField(a, K0)[source]
+from_ComplexField(a, K0)[source]

Convert a mpmath mpc object to dtype.

-from_ExpressionDomain(a, K0)[source]
+from_ExpressionDomain(a, K0)[source]

Convert a EX object to dtype.

-from_FractionField(a, K0)[source]
+from_FractionField(a, K0)[source]

Convert a DMF object to dtype.

-from_GaussianIntegerRing(a, K0)[source]
+from_GaussianIntegerRing(a, K0)[source]

Convert a GaussianRational object to dtype.

-from_GaussianRationalField(a, K0)[source]
+from_GaussianRationalField(a, K0)[source]

Convert a GaussianRational object to dtype.

-from_PolynomialRing(a, K0)[source]
+from_PolynomialRing(a, K0)[source]

Convert a DMP object to dtype.

-from_QQ(a, K0)[source]
+from_QQ(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_QQ_gmpy(a, K0)[source]
+from_QQ_gmpy(a, K0)[source]

Convert a GMPY mpq object to dtype.

-from_QQ_python(a, K0)[source]
+from_QQ_python(a, K0)[source]

Convert a Python Fraction object to dtype.

-from_RealField(a, K0)[source]
+from_RealField(a, K0)[source]

Convert a mpmath mpf object to dtype.

-from_ZZ(a, K0)[source]
+from_ZZ(a, K0)[source]

Convert a Python int object to dtype.

-from_ZZ_gmpy(a, K0)[source]
+from_ZZ_gmpy(a, K0)[source]

Convert a GMPY mpz object to dtype.

-from_ZZ_python(a, K0)[source]
+from_ZZ_python(a, K0)[source]

Convert a Python int object to dtype.

-from_sympy(a)[source]
+from_sympy(a)[source]

Convert SymPy’s expression to dtype.

-get_field()[source]
+get_field()[source]

Returns a field associated with self.

-get_ring()[source]
+get_ring()[source]

Returns a ring associated with self.

-is_negative(a)[source]
+is_negative(a)[source]

Returns True if a is negative.

-is_nonnegative(a)[source]
+is_nonnegative(a)[source]

Returns True if a is non-negative.

-is_nonpositive(a)[source]
+is_nonpositive(a)[source]

Returns True if a is non-positive.

-is_positive(a)[source]
+is_positive(a)[source]

Returns True if a is positive.

-numer(a)[source]
+numer(a)[source]

Returns numerator of a.

-to_sympy(a)[source]
+to_sympy(a)[source]

Convert a to a SymPy object.

@@ -4926,7 +4926,7 @@

Gaussian domains
-class ExpressionDomain.Expression(ex)[source]
+class ExpressionDomain.Expression(ex)[source]

An arbitrary expression.

@@ -4935,7 +4935,7 @@

Gaussian domains

-class sympy.polys.domains.quotientring.QuotientRing(ring, ideal)[source]
+class sympy.polys.domains.quotientring.QuotientRing(ring, ideal)[source]

Class representing (commutative) quotient rings.

You should not usually instantiate this by hand, instead use the constructor from the base ring in the construction.

@@ -4976,7 +4976,7 @@

Sparse polynomialsorder: MonomialOrder | str = LexOrder(),

-)[source] +)[source]

Construct a polynomial ring returning (ring, x_1, ..., x_n).

Parameters:
@@ -5007,7 +5007,7 @@

Sparse polynomials
-sympy.polys.rings.xring(symbols, domain, order=LexOrder())[source]
+sympy.polys.rings.xring(symbols, domain, order=LexOrder())[source]

Construct a polynomial ring returning (ring, (x_1, ..., x_n)).

Parameters:
@@ -5038,7 +5038,7 @@

Sparse polynomials
-sympy.polys.rings.vring(symbols, domain, order=LexOrder())[source]
+sympy.polys.rings.vring(symbols, domain, order=LexOrder())[source]

Construct a polynomial ring and inject x_1, ..., x_n into the global namespace.

Parameters:
@@ -5068,7 +5068,7 @@

Sparse polynomials
-sympy.polys.rings.sring(exprs, *symbols, **options)[source]
+sympy.polys.rings.sring(exprs, *symbols, **options)[source]

Construct a ring deriving generators and domain from options and input expressions.

Parameters:
@@ -5095,11 +5095,11 @@

Sparse polynomials
-class sympy.polys.rings.PolyRing(symbols, domain, order=LexOrder())[source]
+class sympy.polys.rings.PolyRing(symbols, domain, order=LexOrder())[source]

Multivariate distributed polynomial ring.

-add(*objs)[source]
+add(*objs)[source]

Add a sequence of polynomials or containers of polynomials.

Examples

>>> from sympy.polys.rings import ring
@@ -5117,44 +5117,44 @@ 

Sparse polynomials
-add_gens(symbols)[source]
+add_gens(symbols)[source]

Add the elements of symbols as generators to self

-compose(other)[source]
+compose(other)[source]

Add the generators of other to self

-drop(*gens)[source]
+drop(*gens)[source]

Remove specified generators from this ring.

-drop_to_ground(*gens)[source]
+drop_to_ground(*gens)[source]

Remove specified generators from the ring and inject them into its domain.

-index(gen)[source]
+index(gen)[source]

Compute index of gen in self.gens.

-monomial_basis(i)[source]
+monomial_basis(i)[source]

Return the ith-basis element.

-mul(*objs)[source]
+mul(*objs)[source]

Multiply a sequence of polynomials or containers of polynomials.

Examples

>>> from sympy.polys.rings import ring
@@ -5172,7 +5172,7 @@ 

Sparse polynomials
-symmetric_poly(n)[source]
+symmetric_poly(n)[source]

Return the elementary symmetric polynomial of degree n over this ring’s generators.

@@ -5181,17 +5181,17 @@

Sparse polynomials
-class sympy.polys.rings.PolyElement[source]
+class sympy.polys.rings.PolyElement[source]

Element of multivariate distributed polynomial ring.

-almosteq(p2, tolerance=None)[source]
+almosteq(p2, tolerance=None)[source]

Approximate equality test for polynomials.

-cancel(g)[source]
+cancel(g)[source]

Cancel common factors in a rational function f/g.

Examples

>>> from sympy.polys import ring, ZZ
@@ -5206,7 +5206,7 @@ 

Sparse polynomials
-coeff(element)[source]
+coeff(element)[source]

Returns the coefficient that stands next to the given monomial.

Parameters:
@@ -5234,7 +5234,7 @@

Sparse polynomials
-coeff_wrt(x, deg)[source]
+coeff_wrt(x, deg)[source]

Coefficient of self with respect to x**deg.

Treating self as a univariate polynomial in x this finds the coefficient of x**deg as a polynomial in the other generators.

@@ -5279,7 +5279,7 @@

Sparse polynomials
-coeffs(order=None)[source]
+coeffs(order=None)[source]

Ordered list of polynomial coefficients.

Parameters:
@@ -5306,19 +5306,19 @@

Sparse polynomials
-const()[source]
+const()[source]

Returns the constant coefficient.

-content()[source]
+content()[source]

Returns GCD of polynomial’s coefficients.

-copy()[source]
+copy()[source]

Return a copy of polynomial self.

Polynomials are mutable; if one is interested in preserving a polynomial, and one plans to use inplace operations, one @@ -5345,21 +5345,21 @@

Sparse polynomials
-degree(x=None)[source]
+degree(x=None)[source]

The leading degree in x or the main variable.

Note that the degree of 0 is negative infinity (float('-inf'))

-degrees()[source]
+degrees()[source]

A tuple containing leading degrees in all variables.

Note that the degree of 0 is negative infinity (float('-inf'))

-diff(x)[source]
+diff(x)[source]

Computes partial derivative in x.

Examples

>>> from sympy.polys.rings import ring
@@ -5376,7 +5376,7 @@ 

Sparse polynomials
-div(fv)[source]
+div(fv)[source]

Division algorithm, see [CLO] p64.

fv array of polynomials

return qv, r such that @@ -5406,7 +5406,7 @@

Sparse polynomials
-imul_num(c)[source]
+imul_num(c)[source]

multiply inplace the polynomial p by an element in the coefficient ring, provided p is not one of the generators; else multiply not inplace

@@ -5434,25 +5434,25 @@

Sparse polynomials
-itercoeffs()[source]
+itercoeffs()[source]

Iterator over coefficients of a polynomial.

-itermonoms()[source]
+itermonoms()[source]

Iterator over monomials of a polynomial.

-iterterms()[source]
+iterterms()[source]

Iterator over terms of a polynomial.

-leading_expv()[source]
+leading_expv()[source]

Leading monomial tuple according to the monomial ordering.

Examples

>>> from sympy.polys.rings import ring
@@ -5469,7 +5469,7 @@ 

Sparse polynomials
-leading_monom()[source]
+leading_monom()[source]

Leading monomial as a polynomial element.

Examples

>>> from sympy.polys.rings import ring
@@ -5485,7 +5485,7 @@ 

Sparse polynomials
-leading_term()[source]
+leading_term()[source]

Leading term as a polynomial element.

Examples

>>> from sympy.polys.rings import ring
@@ -5501,31 +5501,31 @@ 

Sparse polynomials
-listcoeffs()[source]
+listcoeffs()[source]

Unordered list of polynomial coefficients.

-listmonoms()[source]
+listmonoms()[source]

Unordered list of polynomial monomials.

-listterms()[source]
+listterms()[source]

Unordered list of polynomial terms.

-monic()[source]
+monic()[source]

Divides all coefficients by the leading coefficient.

-monoms(order=None)[source]
+monoms(order=None)[source]

Ordered list of polynomial monomials.

Parameters:
@@ -5552,7 +5552,7 @@

Sparse polynomials
-pdiv(g, x=None)[source]
+pdiv(g, x=None)[source]

Computes the pseudo-division of the polynomial self with respect to g.

The pseudo-division algorithm is used to find the pseudo-quotient q and pseudo-remainder r such that m*f = g*q + r, where m @@ -5629,7 +5629,7 @@

Sparse polynomials
-pexquo(g, x=None)[source]
+pexquo(g, x=None)[source]

Polynomial exact pseudo-quotient in multivariate polynomial ring.

Examples

>>> from sympy.polys import ring, ZZ
@@ -5659,7 +5659,7 @@ 

Sparse polynomials
-pquo(g, x=None)[source]
+pquo(g, x=None)[source]

Polynomial pseudo-quotient in multivariate polynomial ring.

Examples

>>> from sympy.polys import ring, ZZ
@@ -5687,7 +5687,7 @@ 

Sparse polynomials
-prem(g, x=None)[source]
+prem(g, x=None)[source]

Pseudo-remainder of the polynomial self with respect to g.

The pseudo-quotient q and pseudo-remainder r with respect to z when dividing f by g satisfy m*f = g*q + r, @@ -5740,13 +5740,13 @@

Sparse polynomials
-primitive()[source]
+primitive()[source]

Returns content and a primitive polynomial.

-square()[source]
+square()[source]

square of a polynomial

Examples

>>> from sympy.polys.rings import ring
@@ -5763,13 +5763,13 @@ 

Sparse polynomials
-strip_zero()[source]
+strip_zero()[source]

Eliminate monomials with zero coefficient.

-subresultants(g, x=None)[source]
+subresultants(g, x=None)[source]

Computes the subresultant PRS of two polynomials self and g.

Parameters:
@@ -5808,7 +5808,7 @@

Sparse polynomials
-symmetrize()[source]
+symmetrize()[source]

Rewrite self in terms of elementary symmetric polynomials.

Returns:
@@ -5866,21 +5866,21 @@

Sparse polynomials
-tail_degree(x=None)[source]
+tail_degree(x=None)[source]

The tail degree in x or the main variable.

Note that the degree of 0 is negative infinity (float('-inf'))

-tail_degrees()[source]
+tail_degrees()[source]

A tuple containing tail degrees in all variables.

Note that the degree of 0 is negative infinity (float('-inf'))

-terms(order=None)[source]
+terms(order=None)[source]

Ordered list of polynomial terms.

Parameters:
@@ -5913,25 +5913,25 @@

Sparse rational functions
-sympy.polys.fields.field(symbols, domain, order=LexOrder())[source]
+sympy.polys.fields.field(symbols, domain, order=LexOrder())[source]

Construct new rational function field returning (field, x1, …, xn).

-sympy.polys.fields.xfield(symbols, domain, order=LexOrder())[source]
+sympy.polys.fields.xfield(symbols, domain, order=LexOrder())[source]

Construct new rational function field returning (field, (x1, …, xn)).

-sympy.polys.fields.vfield(symbols, domain, order=LexOrder())[source]
+sympy.polys.fields.vfield(symbols, domain, order=LexOrder())[source]

Construct new rational function field and inject generators into global namespace.

-sympy.polys.fields.sfield(exprs, *symbols, **options)[source]
+sympy.polys.fields.sfield(exprs, *symbols, **options)[source]

Construct a field deriving generators and domain from options and input expressions.

@@ -5957,17 +5957,17 @@

Sparse rational functions
-class sympy.polys.fields.FracField(symbols, domain, order=LexOrder())[source]
+class sympy.polys.fields.FracField(symbols, domain, order=LexOrder())[source]

Multivariate distributed rational function field.

-class sympy.polys.fields.FracElement(numer, denom=None)[source]
+class sympy.polys.fields.FracElement(numer, denom=None)[source]

Element of multivariate distributed rational function field.

-diff(x)[source]
+diff(x)[source]

Computes partial derivative in x.

Examples

>>> from sympy.polys.fields import field
@@ -5988,179 +5988,179 @@ 

Sparse rational functions

-class sympy.polys.polyclasses.DMP(rep, dom, lev=None)[source]
+class sympy.polys.polyclasses.DMP(rep, dom, lev=None)[source]

Dense Multivariate Polynomials over \(K\).

-LC()[source]
+LC()[source]

Returns the leading coefficient of f.

-TC()[source]
+TC()[source]

Returns the trailing coefficient of f.

-abs()[source]
+abs()[source]

Make all coefficients in f positive.

-add(g)[source]
+add(g)[source]

Add two multivariate polynomials f and g.

-add_ground(c)[source]
+add_ground(c)[source]

Add an element of the ground domain to f.

-all_coeffs()[source]
+all_coeffs()[source]

Returns all coefficients from f.

-all_monoms()[source]
+all_monoms()[source]

Returns all monomials from f.

-all_terms()[source]
+all_terms()[source]

Returns all terms from a f.

-cancel(g, include=True)[source]
+cancel(g, include=True)[source]

Cancel common factors in a rational function f/g.

-cauchy_lower_bound()[source]
+cauchy_lower_bound()[source]

Computes the Cauchy lower bound on the nonzero roots of f.

-cauchy_upper_bound()[source]
+cauchy_upper_bound()[source]

Computes the Cauchy upper bound on the roots of f.

-clear_denoms()[source]
+clear_denoms()[source]

Clear denominators, but keep the ground domain.

-coeffs(order=None)[source]
+coeffs(order=None)[source]

Returns all non-zero coefficients from f in lex order.

-cofactors(g)[source]
+cofactors(g)[source]

Returns GCD of f and g and their cofactors.

-compose(g)[source]
+compose(g)[source]

Computes functional composition of f and g.

-content()[source]
+content()[source]

Returns GCD of polynomial coefficients.

-convert(dom)[source]
+convert(dom)[source]

Convert f to a DMP over the new domain.

-count_complex_roots(inf=None, sup=None)[source]
+count_complex_roots(inf=None, sup=None)[source]

Return the number of complex roots of f in [inf, sup].

-count_real_roots(inf=None, sup=None)[source]
+count_real_roots(inf=None, sup=None)[source]

Return the number of real roots of f in [inf, sup].

-decompose()[source]
+decompose()[source]

Computes functional decomposition of f.

-deflate()[source]
+deflate()[source]

Reduce degree of \(f\) by mapping \(x_i^m\) to \(y_i\).

-degree(j=0)[source]
+degree(j=0)[source]

Returns the leading degree of f in x_j.

-degree_list()[source]
+degree_list()[source]

Returns a list of degrees of f.

-diff(m=1, j=0)[source]
+diff(m=1, j=0)[source]

Computes the m-th order derivative of f in x_j.

-discriminant()[source]
+discriminant()[source]

Computes discriminant of f.

-div(g)[source]
+div(g)[source]

Polynomial division with remainder of f and g.

-eject(dom, front=False)[source]
+eject(dom, front=False)[source]

Eject selected generators into the ground domain.

-eval(a, j=0)[source]
+eval(a, j=0)[source]

Evaluates f at the given point a in x_j.

-exclude()[source]
+exclude()[source]

Remove useless generators from f.

Returns the removed generators and the new excluded f.

Examples

@@ -6176,91 +6176,91 @@

Dense polynomials
-exquo(g)[source]
+exquo(g)[source]

Computes polynomial exact quotient of f and g.

-exquo_ground(c)[source]
+exquo_ground(c)[source]

Exact quotient of f by a an element of the ground domain.

-factor_list()[source]
+factor_list()[source]

Returns a list of irreducible factors of f.

-factor_list_include()[source]
+factor_list_include()[source]

Returns a list of irreducible factors of f.

-classmethod from_list(rep, lev, dom)[source]
+classmethod from_list(rep, lev, dom)[source]

Create an instance of cls given a list of native coefficients.

-classmethod from_sympy_list(rep, lev, dom)[source]
+classmethod from_sympy_list(rep, lev, dom)[source]

Create an instance of cls given a list of SymPy coefficients.

-gcd(g)[source]
+gcd(g)[source]

Returns polynomial GCD of f and g.

-gcdex(g)[source]
+gcdex(g)[source]

Extended Euclidean algorithm, if univariate.

-gff_list()[source]
+gff_list()[source]

Computes greatest factorial factorization of f.

-ground_new(coeff)[source]
+ground_new(coeff)[source]

Construct a new ground instance of f.

-half_gcdex(g)[source]
+half_gcdex(g)[source]

Half extended Euclidean algorithm, if univariate.

-homogeneous_order()[source]
+homogeneous_order()[source]

Returns the homogeneous order of f.

-homogenize(s)[source]
+homogenize(s)[source]

Return homogeneous polynomial of f

-inject(front=False)[source]
+inject(front=False)[source]

Inject ground domain generators into f.

-integrate(m=1, j=0)[source]
+integrate(m=1, j=0)[source]

Computes the m-th order indefinite integral of f in x_j.

@@ -6277,13 +6277,13 @@

Dense polynomialssqf=False,

-)[source] +)[source]

Compute isolating intervals for roots of f.

-invert(g)[source]
+invert(g)[source]

Invert f modulo g, if possible.

@@ -6361,91 +6361,91 @@

Dense polynomials
-l1_norm()[source]
+l1_norm()[source]

Returns l1 norm of f.

-l2_norm_squared()[source]
+l2_norm_squared()[source]

Return squared l2 norm of f.

-lcm(g)[source]
+lcm(g)[source]

Returns polynomial LCM of f and g.

-lift()[source]
+lift()[source]

Convert algebraic coefficients to rationals.

-max_norm()[source]
+max_norm()[source]

Returns maximum norm of f.

-mignotte_sep_bound_squared()[source]
+mignotte_sep_bound_squared()[source]

Computes the squared Mignotte bound on root separations of f.

-monic()[source]
+monic()[source]

Divides all coefficients by LC(f).

-monoms(order=None)[source]
+monoms(order=None)[source]

Returns all non-zero monomials from f in lex order.

-mul(g)[source]
+mul(g)[source]

Multiply two multivariate polynomials f and g.

-mul_ground(c)[source]
+mul_ground(c)[source]

Multiply f by a an element of the ground domain.

-neg()[source]
+neg()[source]

Negate all coefficients in f.

-norm()[source]
+norm()[source]

Computes Norm(f).

-nth(*N)[source]
+nth(*N)[source]

Returns the n-th coefficient of f.

-pdiv(g)[source]
+pdiv(g)[source]

Polynomial pseudo-division of f and g.

-permute(P)[source]
+permute(P)[source]

Returns a polynomial in \(K[x_{P(1)}, ..., x_{P(n)}]\).

Examples

>>> from sympy.polys.polyclasses import DMP
@@ -6464,43 +6464,43 @@ 

Dense polynomials
-pexquo(g)[source]
+pexquo(g)[source]

Polynomial exact pseudo-quotient of f and g.

-pow(n)[source]
+pow(n)[source]

Raise f to a non-negative power n.

-pquo(g)[source]
+pquo(g)[source]

Polynomial pseudo-quotient of f and g.

-prem(g)[source]
+prem(g)[source]

Polynomial pseudo-remainder of f and g.

-primitive()[source]
+primitive()[source]

Returns content and a primitive form of f.

-quo(g)[source]
+quo(g)[source]

Computes polynomial quotient of f and g.

-quo_ground(c)[source]
+quo_ground(c)[source]

Quotient of f by a an element of the ground domain.

@@ -6516,14 +6516,14 @@

Dense polynomialsfast=False,

-)[source] +)[source]

Refine an isolating interval to the given precision.

eps should be a rational number.

-rem(g)[source]
+rem(g)[source]

Computes polynomial remainder of f and g.

@@ -6535,103 +6535,103 @@

Dense polynomials
-resultant(g, includePRS=False)[source]
+resultant(g, includePRS=False)[source]

Computes resultant of f and g via PRS.

-revert(n)[source]
+revert(n)[source]

Compute f**(-1) mod x**n.

-shift(a)[source]
+shift(a)[source]

Efficiently compute Taylor shift f(x + a).

-shift_list(a)[source]
+shift_list(a)[source]

Efficiently compute Taylor shift f(X + A).

-slice(m, n, j=0)[source]
+slice(m, n, j=0)[source]

Take a continuous subsequence of terms of f.

-sqf_list(all=False)[source]
+sqf_list(all=False)[source]

Returns a list of square-free factors of f.

-sqf_list_include(all=False)[source]
+sqf_list_include(all=False)[source]

Returns a list of square-free factors of f.

-sqf_norm()[source]
+sqf_norm()[source]

Computes square-free norm of f.

-sqf_part()[source]
+sqf_part()[source]

Computes square-free part of f.

-sqr()[source]
+sqr()[source]

Square a multivariate polynomial f.

-sturm()[source]
+sturm()[source]

Computes the Sturm sequence of f.

-sub(g)[source]
+sub(g)[source]

Subtract two multivariate polynomials f and g.

-sub_ground(c)[source]
+sub_ground(c)[source]

Subtract an element of the ground domain from f.

-subresultants(g)[source]
+subresultants(g)[source]

Computes subresultant PRS sequence of f and g.

-terms(order=None)[source]
+terms(order=None)[source]

Returns all non-zero terms from f in lex order.

-terms_gcd()[source]
+terms_gcd()[source]

Remove GCD of terms from the polynomial f.

-to_best()[source]
+to_best()[source]

Convert to DUP_Flint if possible.

This method should be used when the domain or level is changed and it potentially becomes possible to convert from DMP_Python to DUP_Flint.

@@ -6639,74 +6639,74 @@

Dense polynomials
-to_dict(zero=False)[source]
+to_dict(zero=False)[source]

Convert f to a dict representation with native coefficients.

-to_exact()[source]
+to_exact()[source]

Make the ground domain exact.

-to_field()[source]
+to_field()[source]

Make the ground domain a field.

-to_list()[source]
+to_list()[source]

Convert f to a list representation with native coefficients.

-to_ring()[source]
+to_ring()[source]

Make the ground domain a ring.

-to_sympy_dict(zero=False)[source]
+to_sympy_dict(zero=False)[source]

Convert f to a dict representation with SymPy coefficients.

-to_sympy_list()[source]
+to_sympy_list()[source]

Convert f to a list representation with SymPy coefficients.

-to_tuple()[source]
+to_tuple()[source]

Convert f to a tuple representation with native coefficients.

This is needed for hashing.

-total_degree()[source]
+total_degree()[source]

Returns the total degree of f.

-transform(p, q)[source]
+transform(p, q)[source]

Evaluate functional transformation q**n * f(p/q).

-trunc(p)[source]
+trunc(p)[source]

Reduce f modulo a constant p.

-unify_DMP(g)[source]
+unify_DMP(g)[source]

Unify and return DMP instances of f and g.

@@ -6714,53 +6714,53 @@

Dense polynomials
-class sympy.polys.polyclasses.DMF(rep, dom, lev=None)[source]
+class sympy.polys.polyclasses.DMF(rep, dom, lev=None)[source]

Dense Multivariate Fractions over \(K\).

-add(g)[source]
+add(g)[source]

Add two multivariate fractions f and g.

-add_ground(c)[source]
+add_ground(c)[source]

Add an element of the ground domain to f.

-cancel()[source]
+cancel()[source]

Remove common factors from f.num and f.den.

-denom()[source]
+denom()[source]

Returns the denominator of f.

-exquo(g)[source]
+exquo(g)[source]

Computes quotient of fractions f and g.

-frac_unify(g)[source]
+frac_unify(g)[source]

Unify representations of two multivariate fractions.

-half_per(rep, kill=False)[source]
+half_per(rep, kill=False)[source]

Create a DMP out of the given representation.

-invert(check=True)[source]
+invert(check=True)[source]

Computes inverse of a fraction f.

@@ -6778,49 +6778,49 @@

Dense polynomials
-mul(g)[source]
+mul(g)[source]

Multiply two multivariate fractions f and g.

-neg()[source]
+neg()[source]

Negate all coefficients in f.

-numer()[source]
+numer()[source]

Returns the numerator of f.

-per(num, den, cancel=True, kill=False)[source]
+per(num, den, cancel=True, kill=False)[source]

Create a DMF out of the given representation.

-poly_unify(g)[source]
+poly_unify(g)[source]

Unify a multivariate fraction and a polynomial.

-pow(n)[source]
+pow(n)[source]

Raise f to a non-negative power n.

-quo(g)[source]
+quo(g)[source]

Computes quotient of fractions f and g.

-sub(g)[source]
+sub(g)[source]

Subtract two multivariate fractions f and g.

@@ -6828,29 +6828,29 @@

Dense polynomials
-class sympy.polys.polyclasses.ANP(rep, mod, dom)[source]
+class sympy.polys.polyclasses.ANP(rep, mod, dom)[source]

Dense Algebraic Number Polynomials over a field.

-LC()[source]
+LC()[source]

Returns the leading coefficient of f.

-TC()[source]
+TC()[source]

Returns the trailing coefficient of f.

-add_ground(c)[source]
+add_ground(c)[source]

Add an element of the ground domain to f.

-convert(dom)[source]
+convert(dom)[source]

Convert f to a ANP over a new domain.

@@ -6874,74 +6874,74 @@

Dense polynomials
-mod_to_list()[source]
+mod_to_list()[source]

Return f.mod as a list with native coefficients.

-mul_ground(c)[source]
+mul_ground(c)[source]

Multiply f by an element of the ground domain.

-pow(n)[source]
+pow(n)[source]

Raise f to a non-negative power n.

-quo_ground(c)[source]
+quo_ground(c)[source]

Quotient of f by an element of the ground domain.

-sub_ground(c)[source]
+sub_ground(c)[source]

Subtract an element of the ground domain from f.

-to_dict()[source]
+to_dict()[source]

Convert f to a dict representation with native coefficients.

-to_list()[source]
+to_list()[source]

Convert f to a list representation with native coefficients.

-to_sympy_dict()[source]
+to_sympy_dict()[source]

Convert f to a dict representation with SymPy coefficients.

-to_sympy_list()[source]
+to_sympy_list()[source]

Convert f to a list representation with SymPy coefficients.

-to_tuple()[source]
+to_tuple()[source]

Convert f to a tuple representation with native coefficients.

This is needed for hashing.

-unify(g)[source]
+unify(g)[source]

Unify representations of two algebraic numbers.

-unify_ANP(g)[source]
+unify_ANP(g)[source]

Unify and return DMP instances of f and g.

diff --git a/dev/modules/polys/internals.html b/dev/modules/polys/internals.html index fe4d129ae9a..da5ff133d16 100644 --- a/dev/modules/polys/internals.html +++ b/dev/modules/polys/internals.html @@ -853,7 +853,7 @@

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_LC(f, K)[source]
+sympy.polys.densebasic.dmp_LC(f, K)[source]

Return leading coefficient of f.

Examples

>>> from sympy.polys.domains import ZZ
@@ -870,7 +870,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_TC(f, K)[source]
+sympy.polys.densebasic.dmp_TC(f, K)[source]

Return trailing coefficient of f.

Examples

>>> from sympy.polys.domains import ZZ
@@ -887,7 +887,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_ground_LC(f, u, K)[source]
+sympy.polys.densebasic.dmp_ground_LC(f, u, K)[source]

Return the ground leading coefficient.

Examples

>>> from sympy.polys.domains import ZZ
@@ -905,7 +905,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_ground_TC(f, u, K)[source]
+sympy.polys.densebasic.dmp_ground_TC(f, u, K)[source]

Return the ground trailing coefficient.

Examples

>>> from sympy.polys.domains import ZZ
@@ -923,7 +923,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_true_LT(f, u, K)[source]
+sympy.polys.densebasic.dmp_true_LT(f, u, K)[source]

Return the leading term c * x_1**n_1 ... x_k**n_k.

Examples

>>> from sympy.polys.domains import ZZ
@@ -941,7 +941,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_degree(f, u)[source]
+sympy.polys.densebasic.dmp_degree(f, u)[source]

Return the leading degree of f in x_0 in K[X].

Note that the degree of 0 is negative infinity (float('-inf')).

Examples

@@ -964,7 +964,7 @@

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_degree_in(f, j, u)[source]
+sympy.polys.densebasic.dmp_degree_in(f, j, u)[source]

Return the leading degree of f in x_j in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -984,7 +984,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_degree_list(f, u)[source]
+sympy.polys.densebasic.dmp_degree_list(f, u)[source]

Return a list of degrees of f in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1002,7 +1002,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_strip(f, u)[source]
+sympy.polys.densebasic.dmp_strip(f, u)[source]

Remove leading zeros from f in K[X].

Examples

>>> from sympy.polys.densebasic import dmp_strip
@@ -1016,7 +1016,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_validate(f, K=None)[source]
+sympy.polys.densebasic.dmp_validate(f, K=None)[source]

Return the number of levels in f and recursively strip it.

Examples

>>> from sympy.polys.densebasic import dmp_validate
@@ -1036,7 +1036,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dup_reverse(f)[source]
+sympy.polys.densebasic.dup_reverse(f)[source]

Compute x**n * f(1/x), i.e.: reverse f in K[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1054,7 +1054,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_copy(f, u)[source]
+sympy.polys.densebasic.dmp_copy(f, u)[source]

Create a new copy of a polynomial f in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1072,7 +1072,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_to_tuple(f, u)[source]
+sympy.polys.densebasic.dmp_to_tuple(f, u)[source]

Convert \(f\) into a nested tuple of tuples.

This is needed for hashing. This is similar to dmp_copy().

Examples

@@ -1091,7 +1091,7 @@

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_normal(f, u, K)[source]
+sympy.polys.densebasic.dmp_normal(f, u, K)[source]

Normalize a multivariate polynomial in the given domain.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1106,7 +1106,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_convert(f, u, K0, K1)[source]
+sympy.polys.densebasic.dmp_convert(f, u, K0, K1)[source]

Convert the ground domain of f from K0 to K1.

Examples

>>> from sympy.polys.rings import ring
@@ -1127,7 +1127,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_from_sympy(f, u, K)[source]
+sympy.polys.densebasic.dmp_from_sympy(f, u, K)[source]

Convert the ground domain of f from SymPy to K.

Examples

>>> from sympy import S
@@ -1143,7 +1143,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_nth(f, n, u, K)[source]
+sympy.polys.densebasic.dmp_nth(f, n, u, K)[source]

Return the n-th coefficient of f in K[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1163,7 +1163,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_ground_nth(f, N, u, K)[source]
+sympy.polys.densebasic.dmp_ground_nth(f, N, u, K)[source]

Return the ground n-th coefficient of f in K[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1181,7 +1181,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_zero_p(f, u)[source]
+sympy.polys.densebasic.dmp_zero_p(f, u)[source]

Return True if f is zero in K[X].

Examples

>>> from sympy.polys.densebasic import dmp_zero_p
@@ -1197,7 +1197,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_zero(u)[source]
+sympy.polys.densebasic.dmp_zero(u)[source]

Return a multivariate zero.

Examples

>>> from sympy.polys.densebasic import dmp_zero
@@ -1211,7 +1211,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_one_p(f, u, K)[source]
+sympy.polys.densebasic.dmp_one_p(f, u, K)[source]

Return True if f is one in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1226,7 +1226,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_one(u, K)[source]
+sympy.polys.densebasic.dmp_one(u, K)[source]

Return a multivariate one over K.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1241,7 +1241,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_ground_p(f, c, u)[source]
+sympy.polys.densebasic.dmp_ground_p(f, c, u)[source]

Return True if f is constant in K[X].

Examples

>>> from sympy.polys.densebasic import dmp_ground_p
@@ -1257,7 +1257,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_ground(c, u)[source]
+sympy.polys.densebasic.dmp_ground(c, u)[source]

Return a multivariate constant.

Examples

>>> from sympy.polys.densebasic import dmp_ground
@@ -1273,7 +1273,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_zeros(n, u, K)[source]
+sympy.polys.densebasic.dmp_zeros(n, u, K)[source]

Return a list of multivariate zeros.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1290,7 +1290,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_grounds(c, n, u)[source]
+sympy.polys.densebasic.dmp_grounds(c, n, u)[source]

Return a list of multivariate constants.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1307,7 +1307,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_negative_p(f, u, K)[source]
+sympy.polys.densebasic.dmp_negative_p(f, u, K)[source]

Return True if LC(f) is negative.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1324,7 +1324,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_positive_p(f, u, K)[source]
+sympy.polys.densebasic.dmp_positive_p(f, u, K)[source]

Return True if LC(f) is positive.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1341,7 +1341,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_from_dict(f, u, K)[source]
+sympy.polys.densebasic.dmp_from_dict(f, u, K)[source]

Create a K[X] polynomial from a dict.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1358,7 +1358,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_to_dict(f, u, K=None, zero=False)[source]
+sympy.polys.densebasic.dmp_to_dict(f, u, K=None, zero=False)[source]

Convert a K[X] polynomial to a dict``.

Examples

>>> from sympy.polys.densebasic import dmp_to_dict
@@ -1374,7 +1374,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_swap(f, i, j, u, K)[source]
+sympy.polys.densebasic.dmp_swap(f, i, j, u, K)[source]

Transform K[..x_i..x_j..] to K[..x_j..x_i..].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1396,7 +1396,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_permute(f, P, u, K)[source]
+sympy.polys.densebasic.dmp_permute(f, P, u, K)[source]

Return a polynomial in K[x_{P(1)},..,x_{P(n)}].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1416,7 +1416,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_nest(f, l, K)[source]
+sympy.polys.densebasic.dmp_nest(f, l, K)[source]

Return a multivariate value nested l-levels.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1431,7 +1431,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_raise(f, l, u, K)[source]
+sympy.polys.densebasic.dmp_raise(f, l, u, K)[source]

Return a multivariate polynomial raised l-levels.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1449,7 +1449,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_deflate(f, u, K)[source]
+sympy.polys.densebasic.dmp_deflate(f, u, K)[source]

Map x_i**m_i to y_i in a polynomial in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1467,7 +1467,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_multi_deflate(polys, u, K)[source]
+sympy.polys.densebasic.dmp_multi_deflate(polys, u, K)[source]

Map x_i**m_i to y_i in a set of polynomials in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1486,7 +1486,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_inflate(f, M, u, K)[source]
+sympy.polys.densebasic.dmp_inflate(f, M, u, K)[source]

Map y_i to x_i**k_i in a polynomial in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1504,7 +1504,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_exclude(f, u, K)[source]
+sympy.polys.densebasic.dmp_exclude(f, u, K)[source]

Exclude useless levels from f.

Return the levels excluded, the new excluded f, and the new u.

Examples

@@ -1523,7 +1523,7 @@

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_include(f, J, u, K)[source]
+sympy.polys.densebasic.dmp_include(f, J, u, K)[source]

Include useless levels in f.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1541,7 +1541,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_inject(f, u, K, front=False)[source]
+sympy.polys.densebasic.dmp_inject(f, u, K, front=False)[source]

Convert f from K[X][Y] to K[X,Y].

Examples

>>> from sympy.polys.rings import ring
@@ -1562,7 +1562,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_eject(f, u, K, front=False)[source]
+sympy.polys.densebasic.dmp_eject(f, u, K, front=False)[source]

Convert f from K[X,Y] to K[X][Y].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1577,7 +1577,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_terms_gcd(f, u, K)[source]
+sympy.polys.densebasic.dmp_terms_gcd(f, u, K)[source]

Remove GCD of terms from f in K[X].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1595,7 +1595,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_list_terms(f, u, K, order=None)[source]
+sympy.polys.densebasic.dmp_list_terms(f, u, K, order=None)[source]

List all non-zero terms from f in the given order order.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1615,7 +1615,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_apply_pairs(f, g, h, args, u, K)[source]
+sympy.polys.densebasic.dmp_apply_pairs(f, g, h, args, u, K)[source]

Apply h to pairs of coefficients of f and g.

Examples

>>> from sympy.polys.domains import ZZ
@@ -1633,13 +1633,13 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densebasic.dmp_slice(f, m, n, u, K)[source]
+sympy.polys.densebasic.dmp_slice(f, m, n, u, K)[source]

Take a continuous subsequence of terms of f in K[X].

-sympy.polys.densebasic.dup_random(n, a, b, K)[source]
+sympy.polys.densebasic.dup_random(n, a, b, K)[source]

Return a polynomial of degree n with coefficients in [a, b].

Examples

>>> from sympy.polys.domains import ZZ
@@ -1655,7 +1655,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_add_term(f, c, i, u, K)[source]
+sympy.polys.densearith.dmp_add_term(f, c, i, u, K)[source]

Add c(x_2..x_u)*x_0**i to f in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1670,7 +1670,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_sub_term(f, c, i, u, K)[source]
+sympy.polys.densearith.dmp_sub_term(f, c, i, u, K)[source]

Subtract c(x_2..x_u)*x_0**i from f in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1685,7 +1685,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_mul_term(f, c, i, u, K)[source]
+sympy.polys.densearith.dmp_mul_term(f, c, i, u, K)[source]

Multiply f by c(x_2..x_u)*x_0**i in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1700,7 +1700,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_add_ground(f, c, u, K)[source]
+sympy.polys.densearith.dmp_add_ground(f, c, u, K)[source]

Add an element of the ground domain to f.

Examples

>>> from sympy.polys import ring, ZZ
@@ -1715,7 +1715,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_sub_ground(f, c, u, K)[source]
+sympy.polys.densearith.dmp_sub_ground(f, c, u, K)[source]

Subtract an element of the ground domain from f.

Examples

>>> from sympy.polys import ring, ZZ
@@ -1730,7 +1730,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_mul_ground(f, c, u, K)[source]
+sympy.polys.densearith.dmp_mul_ground(f, c, u, K)[source]

Multiply f by a constant value in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1745,7 +1745,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_quo_ground(f, c, u, K)[source]
+sympy.polys.densearith.dmp_quo_ground(f, c, u, K)[source]

Quotient by a constant in K[X].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -1765,7 +1765,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_exquo_ground(f, c, u, K)[source]
+sympy.polys.densearith.dmp_exquo_ground(f, c, u, K)[source]

Exact quotient by a constant in K[X].

Examples

>>> from sympy.polys import ring, QQ
@@ -1780,7 +1780,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dup_lshift(f, n, K)[source]
+sympy.polys.densearith.dup_lshift(f, n, K)[source]

Efficiently multiply f by x**n in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1795,7 +1795,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dup_rshift(f, n, K)[source]
+sympy.polys.densearith.dup_rshift(f, n, K)[source]

Efficiently divide f by x**n in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1812,7 +1812,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_abs(f, u, K)[source]
+sympy.polys.densearith.dmp_abs(f, u, K)[source]

Make all coefficients positive in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1827,7 +1827,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_neg(f, u, K)[source]
+sympy.polys.densearith.dmp_neg(f, u, K)[source]

Negate a polynomial in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1842,7 +1842,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_add(f, g, u, K)[source]
+sympy.polys.densearith.dmp_add(f, g, u, K)[source]

Add dense polynomials in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1857,7 +1857,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_sub(f, g, u, K)[source]
+sympy.polys.densearith.dmp_sub(f, g, u, K)[source]

Subtract dense polynomials in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1872,7 +1872,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_add_mul(f, g, h, u, K)[source]
+sympy.polys.densearith.dmp_add_mul(f, g, h, u, K)[source]

Returns f + g*h where f, g, h are in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1887,7 +1887,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_sub_mul(f, g, h, u, K)[source]
+sympy.polys.densearith.dmp_sub_mul(f, g, h, u, K)[source]

Returns f - g*h where f, g, h are in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1902,7 +1902,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_mul(f, g, u, K)[source]
+sympy.polys.densearith.dmp_mul(f, g, u, K)[source]

Multiply dense polynomials in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1917,7 +1917,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_sqr(f, u, K)[source]
+sympy.polys.densearith.dmp_sqr(f, u, K)[source]

Square dense polynomials in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1932,7 +1932,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_pow(f, n, u, K)[source]
+sympy.polys.densearith.dmp_pow(f, n, u, K)[source]

Raise f to the n-th power in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1947,7 +1947,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_pdiv(f, g, u, K)[source]
+sympy.polys.densearith.dmp_pdiv(f, g, u, K)[source]

Polynomial pseudo-division in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1962,7 +1962,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_prem(f, g, u, K)[source]
+sympy.polys.densearith.dmp_prem(f, g, u, K)[source]

Polynomial pseudo-remainder in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -1977,7 +1977,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_pquo(f, g, u, K)[source]
+sympy.polys.densearith.dmp_pquo(f, g, u, K)[source]

Polynomial exact pseudo-quotient in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2001,7 +2001,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_pexquo(f, g, u, K)[source]
+sympy.polys.densearith.dmp_pexquo(f, g, u, K)[source]

Polynomial pseudo-quotient in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2027,7 +2027,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_rr_div(f, g, u, K)[source]
+sympy.polys.densearith.dmp_rr_div(f, g, u, K)[source]

Multivariate division with remainder over a ring.

Examples

>>> from sympy.polys import ring, ZZ
@@ -2042,7 +2042,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_ff_div(f, g, u, K)[source]
+sympy.polys.densearith.dmp_ff_div(f, g, u, K)[source]

Polynomial division with remainder over a field.

Examples

>>> from sympy.polys import ring, QQ
@@ -2057,7 +2057,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_div(f, g, u, K)[source]
+sympy.polys.densearith.dmp_div(f, g, u, K)[source]

Polynomial division with remainder in K[X].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2077,7 +2077,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_rem(f, g, u, K)[source]
+sympy.polys.densearith.dmp_rem(f, g, u, K)[source]

Returns polynomial remainder in K[X].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2097,7 +2097,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_quo(f, g, u, K)[source]
+sympy.polys.densearith.dmp_quo(f, g, u, K)[source]

Returns exact polynomial quotient in K[X].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2117,7 +2117,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_exquo(f, g, u, K)[source]
+sympy.polys.densearith.dmp_exquo(f, g, u, K)[source]

Returns polynomial quotient in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2143,7 +2143,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_max_norm(f, u, K)[source]
+sympy.polys.densearith.dmp_max_norm(f, u, K)[source]

Returns maximum norm of a polynomial in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2158,7 +2158,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_l1_norm(f, u, K)[source]
+sympy.polys.densearith.dmp_l1_norm(f, u, K)[source]

Returns l1 norm of a polynomial in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2173,7 +2173,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densearith.dmp_expand(polys, u, K)[source]
+sympy.polys.densearith.dmp_expand(polys, u, K)[source]

Multiply together several polynomials in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2189,7 +2189,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_integrate(f, m, u, K)[source]
+sympy.polys.densetools.dmp_integrate(f, m, u, K)[source]

Computes the indefinite integral of f in x_0 in K[X].

Examples

>>> from sympy.polys import ring, QQ
@@ -2206,7 +2206,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_integrate_in(f, m, j, u, K)[source]
+sympy.polys.densetools.dmp_integrate_in(f, m, j, u, K)[source]

Computes the indefinite integral of f in x_j in K[X].

Examples

>>> from sympy.polys import ring, QQ
@@ -2223,7 +2223,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_diff(f, m, u, K)[source]
+sympy.polys.densetools.dmp_diff(f, m, u, K)[source]

m-th order derivative in x_0 of a polynomial in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2243,7 +2243,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_diff_in(f, m, j, u, K)[source]
+sympy.polys.densetools.dmp_diff_in(f, m, j, u, K)[source]

m-th order derivative in x_j of a polynomial in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2263,7 +2263,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_eval(f, a, u, K)[source]
+sympy.polys.densetools.dmp_eval(f, a, u, K)[source]

Evaluate a polynomial at x_0 = a in K[X] using the Horner scheme.

Examples

>>> from sympy.polys import ring, ZZ
@@ -2278,7 +2278,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_eval_in(f, a, j, u, K)[source]
+sympy.polys.densetools.dmp_eval_in(f, a, j, u, K)[source]

Evaluate a polynomial at x_j = a in K[X] using the Horner scheme.

Examples

>>> from sympy.polys import ring, ZZ
@@ -2298,7 +2298,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_eval_tail(f, A, u, K)[source]
+sympy.polys.densetools.dmp_eval_tail(f, A, u, K)[source]

Evaluate a polynomial at x_j = a_j, ... in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2318,7 +2318,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_diff_eval_in(f, m, a, j, u, K)[source]
+sympy.polys.densetools.dmp_diff_eval_in(f, m, a, j, u, K)[source]

Differentiate and evaluate a polynomial in x_j at a in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2338,7 +2338,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_trunc(f, p, u, K)[source]
+sympy.polys.densetools.dmp_trunc(f, p, u, K)[source]

Reduce a K[X] polynomial modulo a polynomial p in K[Y].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2357,7 +2357,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_ground_trunc(f, p, u, K)[source]
+sympy.polys.densetools.dmp_ground_trunc(f, p, u, K)[source]

Reduce a K[X] polynomial modulo a constant p in K.

Examples

>>> from sympy.polys import ring, ZZ
@@ -2375,7 +2375,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_monic(f, K)[source]
+sympy.polys.densetools.dup_monic(f, K)[source]

Divide all coefficients by LC(f) in K[x].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2395,7 +2395,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_ground_monic(f, u, K)[source]
+sympy.polys.densetools.dmp_ground_monic(f, u, K)[source]

Divide all coefficients by LC(f) in K[X].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2421,7 +2421,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_content(f, K)[source]
+sympy.polys.densetools.dup_content(f, K)[source]

Compute the GCD of coefficients of f in K[x].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2447,7 +2447,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_ground_content(f, u, K)[source]
+sympy.polys.densetools.dmp_ground_content(f, u, K)[source]

Compute the GCD of coefficients of f in K[X].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2473,7 +2473,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_primitive(f, K)[source]
+sympy.polys.densetools.dup_primitive(f, K)[source]

Compute content and the primitive form of f in K[x].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2499,7 +2499,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_ground_primitive(f, u, K)[source]
+sympy.polys.densetools.dmp_ground_primitive(f, u, K)[source]

Compute content and the primitive form of f in K[X].

Examples

>>> from sympy.polys import ring, ZZ, QQ
@@ -2525,7 +2525,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_extract(f, g, K)[source]
+sympy.polys.densetools.dup_extract(f, g, K)[source]

Extract common content from a pair of polynomials in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2540,7 +2540,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_ground_extract(f, g, u, K)[source]
+sympy.polys.densetools.dmp_ground_extract(f, g, u, K)[source]

Extract common content from a pair of polynomials in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2555,7 +2555,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_real_imag(f, K)[source]
+sympy.polys.densetools.dup_real_imag(f, K)[source]

Find f1 and f2, such that f(x+I*y) = f1(x,y) + f2(x,y)*I.

Examples

>>> from sympy.polys import ring, ZZ
@@ -2576,7 +2576,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_mirror(f, K)[source]
+sympy.polys.densetools.dup_mirror(f, K)[source]

Evaluate efficiently the composition f(-x) in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2591,7 +2591,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_scale(f, a, K)[source]
+sympy.polys.densetools.dup_scale(f, a, K)[source]

Evaluate efficiently composition f(a*x) in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2606,7 +2606,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_shift(f, a, K)[source]
+sympy.polys.densetools.dup_shift(f, a, K)[source]

Evaluate efficiently Taylor shift f(x + a) in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2621,7 +2621,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_transform(f, p, q, K)[source]
+sympy.polys.densetools.dup_transform(f, p, q, K)[source]

Evaluate functional transformation q**n * f(p/q) in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2636,7 +2636,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_compose(f, g, u, K)[source]
+sympy.polys.densetools.dmp_compose(f, g, u, K)[source]

Evaluate functional composition f(g) in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2651,7 +2651,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_decompose(f, K)[source]
+sympy.polys.densetools.dup_decompose(f, K)[source]

Computes functional decomposition of f in K[x].

Given a univariate polynomial f with coefficients in a field of characteristic zero, returns list [f_1, f_2, ..., f_n], where:

@@ -2688,7 +2688,7 @@

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_lift(f, u, K)[source]
+sympy.polys.densetools.dmp_lift(f, u, K)[source]

Convert algebraic coefficients to integers in K[X].

Examples

>>> from sympy.polys import ring, QQ
@@ -2710,7 +2710,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dup_sign_variations(f, K)[source]
+sympy.polys.densetools.dup_sign_variations(f, K)[source]

Compute the number of sign variations of f in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -2725,7 +2725,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_clear_denoms(f, u, K0, K1=None, convert=False)[source]
+sympy.polys.densetools.dmp_clear_denoms(f, u, K0, K1=None, convert=False)[source]

Clear denominators, i.e. transform K_0 to K_1.

Examples

>>> from sympy.polys import ring, QQ
@@ -2745,7 +2745,7 @@ 

Manipulation of dense, multivariate polynomials
-sympy.polys.densetools.dmp_revert(f, g, u, K)[source]
+sympy.polys.densetools.dmp_revert(f, g, u, K)[source]

Compute f**(-1) mod x**n using Newton iteration.

Examples

>>> from sympy.polys import ring, QQ
@@ -2765,7 +2765,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients fields.

-sympy.polys.galoistools.gf_crt(U, M, K=None)[source]
+sympy.polys.galoistools.gf_crt(U, M, K=None)[source]

Chinese Remainder Theorem.

Given a set of integer residues u_0,...,u_n and a set of co-prime integer moduli m_0,...,m_n, returns an integer @@ -2798,7 +2798,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_crt1(M, K)[source]
+sympy.polys.galoistools.gf_crt1(M, K)[source]

First part of the Chinese Remainder Theorem.

Examples

>>> from sympy.polys.domains import ZZ
@@ -2839,7 +2839,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_crt2(U, M, p, E, S, K)[source]
+sympy.polys.galoistools.gf_crt2(U, M, p, E, S, K)[source]

Second part of the Chinese Remainder Theorem.

See gf_crt1 for usage.

Examples

@@ -2870,7 +2870,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_int(a, p)[source]
+sympy.polys.galoistools.gf_int(a, p)[source]

Coerce a mod p to an integer in the range [-p/2, p/2].

Examples

>>> from sympy.polys.galoistools import gf_int
@@ -2886,7 +2886,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_degree(f)[source]
+sympy.polys.galoistools.gf_degree(f)[source]

Return the leading degree of f.

Examples

>>> from sympy.polys.galoistools import gf_degree
@@ -2902,7 +2902,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_LC(f, K)[source]
+sympy.polys.galoistools.gf_LC(f, K)[source]

Return the leading coefficient of f.

Examples

>>> from sympy.polys.domains import ZZ
@@ -2917,7 +2917,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_TC(f, K)[source]
+sympy.polys.galoistools.gf_TC(f, K)[source]

Return the trailing coefficient of f.

Examples

>>> from sympy.polys.domains import ZZ
@@ -2932,7 +2932,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_strip(f)[source]
+sympy.polys.galoistools.gf_strip(f)[source]

Remove leading zeros from f.

Examples

>>> from sympy.polys.galoistools import gf_strip
@@ -2946,7 +2946,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_trunc(f, p)[source]
+sympy.polys.galoistools.gf_trunc(f, p)[source]

Reduce all coefficients modulo p.

Examples

>>> from sympy.polys.galoistools import gf_trunc
@@ -2960,7 +2960,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_normal(f, p, K)[source]
+sympy.polys.galoistools.gf_normal(f, p, K)[source]

Normalize all coefficients in K.

Examples

>>> from sympy.polys.domains import ZZ
@@ -2975,7 +2975,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_from_dict(f, p, K)[source]
+sympy.polys.galoistools.gf_from_dict(f, p, K)[source]

Create a GF(p)[x] polynomial from a dict.

Examples

>>> from sympy.polys.domains import ZZ
@@ -2990,7 +2990,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_to_dict(f, p, symmetric=True)[source]
+sympy.polys.galoistools.gf_to_dict(f, p, symmetric=True)[source]

Convert a GF(p)[x] polynomial to a dict.

Examples

>>> from sympy.polys.galoistools import gf_to_dict
@@ -3006,7 +3006,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_from_int_poly(f, p)[source]
+sympy.polys.galoistools.gf_from_int_poly(f, p)[source]

Create a GF(p)[x] polynomial from Z[x].

Examples

>>> from sympy.polys.galoistools import gf_from_int_poly
@@ -3020,7 +3020,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_to_int_poly(f, p, symmetric=True)[source]
+sympy.polys.galoistools.gf_to_int_poly(f, p, symmetric=True)[source]

Convert a GF(p)[x] polynomial to Z[x].

Examples

>>> from sympy.polys.galoistools import gf_to_int_poly
@@ -3036,7 +3036,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_neg(f, p, K)[source]
+sympy.polys.galoistools.gf_neg(f, p, K)[source]

Negate a polynomial in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3051,7 +3051,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_add_ground(f, a, p, K)[source]
+sympy.polys.galoistools.gf_add_ground(f, a, p, K)[source]

Compute f + a where f in GF(p)[x] and a in GF(p).

Examples

>>> from sympy.polys.domains import ZZ
@@ -3066,7 +3066,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_sub_ground(f, a, p, K)[source]
+sympy.polys.galoistools.gf_sub_ground(f, a, p, K)[source]

Compute f - a where f in GF(p)[x] and a in GF(p).

Examples

>>> from sympy.polys.domains import ZZ
@@ -3081,7 +3081,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_mul_ground(f, a, p, K)[source]
+sympy.polys.galoistools.gf_mul_ground(f, a, p, K)[source]

Compute f * a where f in GF(p)[x] and a in GF(p).

Examples

>>> from sympy.polys.domains import ZZ
@@ -3096,7 +3096,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_quo_ground(f, a, p, K)[source]
+sympy.polys.galoistools.gf_quo_ground(f, a, p, K)[source]

Compute f/a where f in GF(p)[x] and a in GF(p).

Examples

>>> from sympy.polys.domains import ZZ
@@ -3111,7 +3111,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_add(f, g, p, K)[source]
+sympy.polys.galoistools.gf_add(f, g, p, K)[source]

Add polynomials in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3126,7 +3126,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_sub(f, g, p, K)[source]
+sympy.polys.galoistools.gf_sub(f, g, p, K)[source]

Subtract polynomials in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3141,7 +3141,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_mul(f, g, p, K)[source]
+sympy.polys.galoistools.gf_mul(f, g, p, K)[source]

Multiply polynomials in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3156,7 +3156,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_sqr(f, p, K)[source]
+sympy.polys.galoistools.gf_sqr(f, p, K)[source]

Square polynomials in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3171,7 +3171,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_add_mul(f, g, h, p, K)[source]
+sympy.polys.galoistools.gf_add_mul(f, g, h, p, K)[source]

Returns f + g*h where f, g, h in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3184,7 +3184,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_sub_mul(f, g, h, p, K)[source]
+sympy.polys.galoistools.gf_sub_mul(f, g, h, p, K)[source]

Compute f - g*h where f, g, h in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3199,7 +3199,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_expand(F, p, K)[source]
+sympy.polys.galoistools.gf_expand(F, p, K)[source]

Expand results of factor() in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3214,7 +3214,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_div(f, g, p, K)[source]
+sympy.polys.galoistools.gf_div(f, g, p, K)[source]

Division with remainder in GF(p)[x].

Given univariate polynomials f and g with coefficients in a finite field with p elements, returns polynomials q and r @@ -3247,7 +3247,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_rem(f, g, p, K)[source]
+sympy.polys.galoistools.gf_rem(f, g, p, K)[source]

Compute polynomial remainder in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3262,7 +3262,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_quo(f, g, p, K)[source]
+sympy.polys.galoistools.gf_quo(f, g, p, K)[source]

Compute exact quotient in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3279,7 +3279,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_exquo(f, g, p, K)[source]
+sympy.polys.galoistools.gf_exquo(f, g, p, K)[source]

Compute polynomial quotient in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3300,7 +3300,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_lshift(f, n, K)[source]
+sympy.polys.galoistools.gf_lshift(f, n, K)[source]

Efficiently multiply f by x**n.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3315,7 +3315,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_rshift(f, n, K)[source]
+sympy.polys.galoistools.gf_rshift(f, n, K)[source]

Efficiently divide f by x**n.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3330,7 +3330,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_pow(f, n, p, K)[source]
+sympy.polys.galoistools.gf_pow(f, n, p, K)[source]

Compute f**n in GF(p)[x] using repeated squaring.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3345,7 +3345,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_pow_mod(f, n, g, p, K)[source]
+sympy.polys.galoistools.gf_pow_mod(f, n, g, p, K)[source]

Compute f**n in GF(p)[x]/(g) using repeated squaring.

Given polynomials f and g in GF(p)[x] and a non-negative integer n, efficiently computes f**n (mod g) i.e. the remainder @@ -3370,7 +3370,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_gcd(f, g, p, K)[source]
+sympy.polys.galoistools.gf_gcd(f, g, p, K)[source]

Euclidean Algorithm in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3385,7 +3385,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_lcm(f, g, p, K)[source]
+sympy.polys.galoistools.gf_lcm(f, g, p, K)[source]

Compute polynomial LCM in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3400,7 +3400,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_cofactors(f, g, p, K)[source]
+sympy.polys.galoistools.gf_cofactors(f, g, p, K)[source]

Compute polynomial GCD and cofactors in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3415,7 +3415,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_gcdex(f, g, p, K)[source]
+sympy.polys.galoistools.gf_gcdex(f, g, p, K)[source]

Extended Euclidean Algorithm in GF(p)[x].

Given polynomials f and g in GF(p)[x], computes polynomials s, t and h, such that h = gcd(f, g) and s*f + t*g = h. @@ -3450,7 +3450,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_monic(f, p, K)[source]
+sympy.polys.galoistools.gf_monic(f, p, K)[source]

Compute LC and a monic polynomial in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3465,7 +3465,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_diff(f, p, K)[source]
+sympy.polys.galoistools.gf_diff(f, p, K)[source]

Differentiate polynomial in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3480,7 +3480,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_eval(f, a, p, K)[source]
+sympy.polys.galoistools.gf_eval(f, a, p, K)[source]

Evaluate f(a) in GF(p) using Horner scheme.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3495,7 +3495,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_multi_eval(f, A, p, K)[source]
+sympy.polys.galoistools.gf_multi_eval(f, A, p, K)[source]

Evaluate f(a) for a in [a_1, ..., a_n].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3510,7 +3510,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_compose(f, g, p, K)[source]
+sympy.polys.galoistools.gf_compose(f, g, p, K)[source]

Compute polynomial composition f(g) in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3525,7 +3525,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_compose_mod(g, h, f, p, K)[source]
+sympy.polys.galoistools.gf_compose_mod(g, h, f, p, K)[source]

Compute polynomial composition g(h) in GF(p)[x]/(f).

Examples

>>> from sympy.polys.domains import ZZ
@@ -3540,7 +3540,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_trace_map(a, b, c, n, f, p, K)[source]
+sympy.polys.galoistools.gf_trace_map(a, b, c, n, f, p, K)[source]

Compute polynomial trace map in GF(p)[x]/(f).

Given a polynomial f in GF(p)[x], polynomials a, b, c in the quotient ring GF(p)[x]/(f) such that b = c**t @@ -3573,7 +3573,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_random(n, p, K)[source]
+sympy.polys.galoistools.gf_random(n, p, K)[source]

Generate a random polynomial in GF(p)[x] of degree n.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3586,7 +3586,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_irreducible(n, p, K)[source]
+sympy.polys.galoistools.gf_irreducible(n, p, K)[source]

Generate random irreducible polynomial of degree n in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3599,7 +3599,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_irreducible_p(f, p, K)[source]
+sympy.polys.galoistools.gf_irreducible_p(f, p, K)[source]

Test irreducibility of a polynomial f in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3616,7 +3616,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_sqf_p(f, p, K)[source]
+sympy.polys.galoistools.gf_sqf_p(f, p, K)[source]

Return True if f is square-free in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3633,7 +3633,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_sqf_part(f, p, K)[source]
+sympy.polys.galoistools.gf_sqf_part(f, p, K)[source]

Return square-free part of a GF(p)[x] polynomial.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3648,7 +3648,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_sqf_list(f, p, K, all=False)[source]
+sympy.polys.galoistools.gf_sqf_list(f, p, K, all=False)[source]

Return the square-free decomposition of a GF(p)[x] polynomial.

Given a polynomial f in GF(p)[x], returns the leading coefficient of f and a square-free decomposition f_1**e_1 f_2**e_2 ... f_k**e_k @@ -3693,7 +3693,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_Qmatrix(f, p, K)[source]
+sympy.polys.galoistools.gf_Qmatrix(f, p, K)[source]

Calculate Berlekamp’s Q matrix.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3716,7 +3716,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_Qbasis(Q, p, K)[source]
+sympy.polys.galoistools.gf_Qbasis(Q, p, K)[source]

Compute a basis of the kernel of Q.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3735,7 +3735,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_berlekamp(f, p, K)[source]
+sympy.polys.galoistools.gf_berlekamp(f, p, K)[source]

Factor a square-free f in GF(p)[x] for small p.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3750,7 +3750,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_zassenhaus(f, p, K)[source]
+sympy.polys.galoistools.gf_zassenhaus(f, p, K)[source]

Factor a square-free f in GF(p)[x] for medium p.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3765,7 +3765,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_shoup(f, p, K)[source]
+sympy.polys.galoistools.gf_shoup(f, p, K)[source]

Factor a square-free f in GF(p)[x] for large p.

Examples

>>> from sympy.polys.domains import ZZ
@@ -3780,7 +3780,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_factor_sqf(f, p, K, method=None)[source]
+sympy.polys.galoistools.gf_factor_sqf(f, p, K, method=None)[source]

Factor a square-free polynomial f in GF(p)[x].

Examples

>>> from sympy.polys.domains import ZZ
@@ -3795,7 +3795,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_factor(f, p, K)[source]
+sympy.polys.galoistools.gf_factor(f, p, K)[source]

Factor (non square-free) polynomials in GF(p)[x].

Given a possibly non square-free polynomial f in GF(p)[x], returns its complete factorization into irreducibles:

@@ -3844,7 +3844,7 @@

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_value(f, a)[source]
+sympy.polys.galoistools.gf_value(f, a)[source]

Value of polynomial ‘f’ at ‘a’ in field R.

Examples

>>> from sympy.polys.galoistools import gf_value
@@ -3858,7 +3858,7 @@ 

Manipulation of dense, univariate polynomials with finite field coefficients
-sympy.polys.galoistools.gf_csolve(f, n)[source]
+sympy.polys.galoistools.gf_csolve(f, n)[source]

To solve f(x) congruent 0 mod(n).

n is divided into canonical factors and f(x) cong 0 mod(p**e) will be solved for each factor. Applying the Chinese Remainder Theorem to the @@ -3904,7 +3904,7 @@

Manipulation of sparse, distributed polynomials and vectors\(f_1, f_2, \ldots\).

-sympy.polys.distributedmodules.sdm_monomial_mul(M, X)[source]
+sympy.polys.distributedmodules.sdm_monomial_mul(M, X)[source]

Multiply tuple X representing a monomial of \(K[X]\) into the tuple M representing a monomial of \(F\).

Examples

@@ -3918,7 +3918,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_monomial_deg(M)[source]
+sympy.polys.distributedmodules.sdm_monomial_deg(M)[source]

Return the total degree of M.

Examples

For example, the total degree of \(x^2 y f_5\) is 3:

@@ -3931,7 +3931,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_monomial_divides(A, B)[source]
+sympy.polys.distributedmodules.sdm_monomial_divides(A, B)[source]

Does there exist a (polynomial) monomial X such that XA = B?

Examples

Positive examples:

@@ -3977,19 +3977,19 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_LC(f, K)[source]
+sympy.polys.distributedmodules.sdm_LC(f, K)[source]

Returns the leading coefficient of f.

-sympy.polys.distributedmodules.sdm_to_dict(f)[source]
+sympy.polys.distributedmodules.sdm_to_dict(f)[source]

Make a dictionary from a distributed polynomial.

-sympy.polys.distributedmodules.sdm_from_dict(d, O)[source]
+sympy.polys.distributedmodules.sdm_from_dict(d, O)[source]

Create an sdm from a dictionary.

Here O is the monomial order to use.

Examples

@@ -4004,7 +4004,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_add(f, g, O, K)[source]
+sympy.polys.distributedmodules.sdm_add(f, g, O, K)[source]

Add two module elements f, g.

Addition is done over the ground field K, monomials are ordered according to O.

@@ -4036,7 +4036,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_LM(f)[source]
+sympy.polys.distributedmodules.sdm_LM(f)[source]

Returns the leading monomial of f.

Only valid if \(f \ne 0\).

Examples

@@ -4051,7 +4051,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_LT(f)[source]
+sympy.polys.distributedmodules.sdm_LT(f)[source]

Returns the leading term of f.

Only valid if \(f \ne 0\).

Examples

@@ -4066,7 +4066,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_mul_term(f, term, O, K)[source]
+sympy.polys.distributedmodules.sdm_mul_term(f, term, O, K)[source]

Multiply a distributed module element f by a (polynomial) term term.

Multiplication of coefficients is done over the ground field K, and monomials are ordered according to O.

@@ -4098,13 +4098,13 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_zero()[source]
+sympy.polys.distributedmodules.sdm_zero()[source]

Return the zero module element.

-sympy.polys.distributedmodules.sdm_deg(f)[source]
+sympy.polys.distributedmodules.sdm_deg(f)[source]

Degree of f.

This is the maximum of the degrees of all its monomials. Invalid if f is zero.

@@ -4118,7 +4118,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_from_vector(vec, O, K, **opts)[source]
+sympy.polys.distributedmodules.sdm_from_vector(vec, O, K, **opts)[source]

Create an sdm from an iterable of expressions.

Coefficients are created in the ground field K, and terms are ordered according to monomial order O. Named arguments are passed on to the @@ -4135,7 +4135,7 @@

Manipulation of sparse, distributed polynomials and vectors
-sympy.polys.distributedmodules.sdm_to_vector(f, gens, K, n=None)[source]
+sympy.polys.distributedmodules.sdm_to_vector(f, gens, K, n=None)[source]

Convert sdm f into a list of polynomial expressions.

The generators for the polynomial ring are specified via gens. The rank of the module is guessed, or passed via n. The ground field is assumed @@ -4209,7 +4209,7 @@

Classical remainder sequence
-sympy.polys.euclidtools.dmp_half_gcdex(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_half_gcdex(f, g, u, K)[source]

Half extended Euclidean algorithm in \(F[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4220,7 +4220,7 @@ 

Classical remainder sequence
-sympy.polys.euclidtools.dmp_gcdex(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_gcdex(f, g, u, K)[source]

Extended Euclidean algorithm in \(F[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4231,7 +4231,7 @@ 

Classical remainder sequence
-sympy.polys.euclidtools.dmp_invert(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_invert(f, g, u, K)[source]

Compute multiplicative inverse of \(f\) modulo \(g\) in \(F[X]\).

Examples

>>> from sympy.polys import ring, QQ
@@ -4242,7 +4242,7 @@ 

Classical remainder sequence
-sympy.polys.euclidtools.dmp_euclidean_prs(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_euclidean_prs(f, g, u, K)[source]

Euclidean polynomial remainder sequence (PRS) in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4282,7 +4282,7 @@ 

Simplified remainder sequences
-sympy.polys.euclidtools.dmp_primitive_prs(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_primitive_prs(f, g, u, K)[source]

Primitive polynomial remainder sequence (PRS) in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4400,7 +4400,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_inner_subresultants(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_inner_subresultants(f, g, u, K)[source]

Subresultant PRS algorithm in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4427,7 +4427,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_subresultants(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_subresultants(f, g, u, K)[source]

Computes subresultant PRS of two polynomials in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4450,7 +4450,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_prs_resultant(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_prs_resultant(f, g, u, K)[source]

Resultant algorithm in \(K[X]\) using subresultant PRS.

Examples

>>> from sympy.polys import ring, ZZ
@@ -4480,7 +4480,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_zz_modular_resultant(f, g, p, u, K)[source]
+sympy.polys.euclidtools.dmp_zz_modular_resultant(f, g, p, u, K)[source]

Compute resultant of \(f\) and \(g\) modulo a prime \(p\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4499,7 +4499,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_zz_collins_resultant(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_zz_collins_resultant(f, g, u, K)[source]

Collins’s modular resultant algorithm in \(Z[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4518,7 +4518,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_qq_collins_resultant(f, g, u, K0)[source]
+sympy.polys.euclidtools.dmp_qq_collins_resultant(f, g, u, K0)[source]

Collins’s modular resultant algorithm in \(Q[X]\).

Examples

>>> from sympy.polys import ring, QQ
@@ -4537,7 +4537,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_resultant(f, g, u, K, includePRS=False)[source]
+sympy.polys.euclidtools.dmp_resultant(f, g, u, K, includePRS=False)[source]

Computes resultant of two polynomials in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4556,7 +4556,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_discriminant(f, u, K)[source]
+sympy.polys.euclidtools.dmp_discriminant(f, u, K)[source]

Computes discriminant of a polynomial in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4571,7 +4571,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_rr_prs_gcd(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_rr_prs_gcd(f, g, u, K)[source]

Computes polynomial GCD using subresultants over a ring.

Returns (h, cff, cfg) such that a = gcd(f, g), cff = quo(f, h), and cfg = quo(g, h).

@@ -4592,7 +4592,7 @@

Subresultant sequence
-sympy.polys.euclidtools.dmp_ff_prs_gcd(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_ff_prs_gcd(f, g, u, K)[source]

Computes polynomial GCD using subresultants over a field.

Returns (h, cff, cfg) such that a = gcd(f, g), cff = quo(f, h), and cfg = quo(g, h).

@@ -4613,7 +4613,7 @@

Subresultant sequence
-sympy.polys.euclidtools.dmp_zz_heu_gcd(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_zz_heu_gcd(f, g, u, K)[source]

Heuristic polynomial GCD in \(Z[X]\).

Given univariate polynomials \(f\) and \(g\) in \(Z[X]\), returns their GCD and cofactors, i.e. polynomials h, cff and cfg @@ -4655,7 +4655,7 @@

Subresultant sequence
-sympy.polys.euclidtools.dmp_qq_heu_gcd(f, g, u, K0)[source]
+sympy.polys.euclidtools.dmp_qq_heu_gcd(f, g, u, K0)[source]

Heuristic polynomial GCD in \(Q[X]\).

Returns (h, cff, cfg) such that a = gcd(f, g), cff = quo(f, h), and cfg = quo(g, h).

@@ -4676,7 +4676,7 @@

Subresultant sequence
-sympy.polys.euclidtools.dmp_inner_gcd(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_inner_gcd(f, g, u, K)[source]

Computes polynomial GCD and cofactors of \(f\) and \(g\) in \(K[X]\).

Returns (h, cff, cfg) such that a = gcd(f, g), cff = quo(f, h), and cfg = quo(g, h).

@@ -4697,7 +4697,7 @@

Subresultant sequence
-sympy.polys.euclidtools.dmp_gcd(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_gcd(f, g, u, K)[source]

Computes polynomial GCD of \(f\) and \(g\) in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4716,7 +4716,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_lcm(f, g, u, K)[source]
+sympy.polys.euclidtools.dmp_lcm(f, g, u, K)[source]

Computes polynomial LCM of \(f\) and \(g\) in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4735,7 +4735,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_content(f, u, K)[source]
+sympy.polys.euclidtools.dmp_content(f, u, K)[source]

Returns GCD of multivariate coefficients.

Examples

>>> from sympy.polys import ring, ZZ
@@ -4750,7 +4750,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_primitive(f, u, K)[source]
+sympy.polys.euclidtools.dmp_primitive(f, u, K)[source]

Returns multivariate content and a primitive polynomial.

Examples

>>> from sympy.polys import ring, ZZ
@@ -4765,7 +4765,7 @@ 

Subresultant sequence
-sympy.polys.euclidtools.dmp_cancel(f, g, u, K, include=True)[source]
+sympy.polys.euclidtools.dmp_cancel(f, g, u, K, include=True)[source]

Cancel common factors in a rational function \(f/g\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -4781,7 +4781,7 @@ 

Subresultant sequencePolynomial factorization in characteristic zero:

-sympy.polys.factortools.dup_trial_division(f, factors, K)[source]
+sympy.polys.factortools.dup_trial_division(f, factors, K)[source]

Determine multiplicities of factors for a univariate polynomial using trial division.

An error will be raised if any factor does not divide f.

@@ -4789,7 +4789,7 @@

Subresultant sequence
-sympy.polys.factortools.dmp_trial_division(f, factors, u, K)[source]
+sympy.polys.factortools.dmp_trial_division(f, factors, u, K)[source]

Determine multiplicities of factors for a multivariate polynomial using trial division.

An error will be raised if any factor does not divide f.

@@ -4797,7 +4797,7 @@

Subresultant sequence
-sympy.polys.factortools.dup_zz_mignotte_bound(f, K)[source]
+sympy.polys.factortools.dup_zz_mignotte_bound(f, K)[source]

The Knuth-Cohen variant of Mignotte bound for univariate polynomials in K[x].

Examples

@@ -4833,13 +4833,13 @@

Subresultant sequence
-sympy.polys.factortools.dmp_zz_mignotte_bound(f, u, K)[source]
+sympy.polys.factortools.dmp_zz_mignotte_bound(f, u, K)[source]

Mignotte bound for multivariate polynomials in \(K[X]\).

-sympy.polys.factortools.dup_zz_hensel_step(m, f, g, h, s, t, K)[source]
+sympy.polys.factortools.dup_zz_hensel_step(m, f, g, h, s, t, K)[source]

One step in Hensel lifting in \(Z[x]\).

Given positive integer \(m\) and \(Z[x]\) polynomials \(f\), \(g\), \(h\), \(s\) and \(t\) such that:

@@ -4870,7 +4870,7 @@

Subresultant sequence
-sympy.polys.factortools.dup_zz_hensel_lift(p, f, f_list, l, K)[source]
+sympy.polys.factortools.dup_zz_hensel_lift(p, f, f_list, l, K)[source]

Multifactor Hensel lifting in \(Z[x]\).

Given a prime \(p\), polynomial \(f\) over \(Z[x]\) such that \(lc(f)\) is a unit modulo \(p\), monic pair-wise coprime polynomials \(f_i\) @@ -4896,19 +4896,19 @@

Subresultant sequence
-sympy.polys.factortools.dup_zz_zassenhaus(f, K)[source]
+sympy.polys.factortools.dup_zz_zassenhaus(f, K)[source]

Factor primitive square-free polynomials in \(Z[x]\).

-sympy.polys.factortools.dup_zz_irreducible_p(f, K)[source]
+sympy.polys.factortools.dup_zz_irreducible_p(f, K)[source]

Test irreducibility using Eisenstein’s criterion.

-sympy.polys.factortools.dup_cyclotomic_p(f, K, irreducible=False)[source]
+sympy.polys.factortools.dup_cyclotomic_p(f, K, irreducible=False)[source]

Efficiently test if f is a cyclotomic polynomial.

Examples

>>> from sympy.polys import ring, ZZ
@@ -4933,13 +4933,13 @@ 

Subresultant sequence
-sympy.polys.factortools.dup_zz_cyclotomic_poly(n, K)[source]
+sympy.polys.factortools.dup_zz_cyclotomic_poly(n, K)[source]

Efficiently generate n-th cyclotomic polynomial.

-sympy.polys.factortools.dup_zz_cyclotomic_factor(f, K)[source]
+sympy.polys.factortools.dup_zz_cyclotomic_factor(f, K)[source]

Efficiently factor polynomials \(x**n - 1\) and \(x**n + 1\) in \(Z[x]\).

Given a univariate polynomial \(f\) in \(Z[x]\) returns a list of factors of \(f\), provided that \(f\) is in the form \(x**n - 1\) or \(x**n + 1\) for @@ -4958,13 +4958,13 @@

Subresultant sequence
-sympy.polys.factortools.dup_zz_factor_sqf(f, K)[source]
+sympy.polys.factortools.dup_zz_factor_sqf(f, K)[source]

Factor square-free (non-primitive) polynomials in \(Z[x]\).

-sympy.polys.factortools.dup_zz_factor(f, K)[source]
+sympy.polys.factortools.dup_zz_factor(f, K)[source]

Factor (non square-free) polynomials in \(Z[x]\).

Given a univariate polynomial \(f\) in \(Z[x]\) computes its complete factorization \(f_1, ..., f_n\) into irreducibles over integers:

@@ -5008,43 +5008,43 @@

Subresultant sequence
-sympy.polys.factortools.dmp_zz_wang_non_divisors(E, cs, ct, K)[source]
+sympy.polys.factortools.dmp_zz_wang_non_divisors(E, cs, ct, K)[source]

Wang/EEZ: Compute a set of valid divisors.

-sympy.polys.factortools.dmp_zz_wang_test_points(f, T, ct, A, u, K)[source]
+sympy.polys.factortools.dmp_zz_wang_test_points(f, T, ct, A, u, K)[source]

Wang/EEZ: Test evaluation points for suitability.

-sympy.polys.factortools.dmp_zz_wang_lead_coeffs(f, T, cs, E, H, A, u, K)[source]
+sympy.polys.factortools.dmp_zz_wang_lead_coeffs(f, T, cs, E, H, A, u, K)[source]

Wang/EEZ: Compute correct leading coefficients.

-sympy.polys.factortools.dup_zz_diophantine(F, m, p, K)[source]
+sympy.polys.factortools.dup_zz_diophantine(F, m, p, K)[source]

Wang/EEZ: Solve univariate Diophantine equations.

-sympy.polys.factortools.dmp_zz_diophantine(F, c, A, d, p, u, K)[source]
+sympy.polys.factortools.dmp_zz_diophantine(F, c, A, d, p, u, K)[source]

Wang/EEZ: Solve multivariate Diophantine equations.

-sympy.polys.factortools.dmp_zz_wang_hensel_lifting(f, H, LC, A, p, u, K)[source]
+sympy.polys.factortools.dmp_zz_wang_hensel_lifting(f, H, LC, A, p, u, K)[source]

Wang/EEZ: Parallel Hensel lifting algorithm.

-sympy.polys.factortools.dmp_zz_wang(f, u, K, mod=None, seed=None)[source]
+sympy.polys.factortools.dmp_zz_wang(f, u, K, mod=None, seed=None)[source]

Factor primitive square-free polynomials in \(Z[X]\).

Given a multivariate polynomial \(f\) in \(Z[x_1,...,x_n]\), which is primitive and square-free in \(x_1\), computes factorization of \(f\) into @@ -5077,7 +5077,7 @@

Subresultant sequence
-sympy.polys.factortools.dmp_zz_factor(f, u, K)[source]
+sympy.polys.factortools.dmp_zz_factor(f, u, K)[source]

Factor (non square-free) polynomials in \(Z[X]\).

Given a multivariate polynomial \(f\) in \(Z[x]\) computes its complete factorization \(f_1, \dots, f_n\) into irreducibles over integers:

@@ -5115,31 +5115,31 @@

Subresultant sequence
-sympy.polys.factortools.dup_qq_i_factor(f, K0)[source]
+sympy.polys.factortools.dup_qq_i_factor(f, K0)[source]

Factor univariate polynomials into irreducibles in \(QQ_I[x]\).

-sympy.polys.factortools.dup_zz_i_factor(f, K0)[source]
+sympy.polys.factortools.dup_zz_i_factor(f, K0)[source]

Factor univariate polynomials into irreducibles in \(ZZ_I[x]\).

-sympy.polys.factortools.dmp_qq_i_factor(f, u, K0)[source]
+sympy.polys.factortools.dmp_qq_i_factor(f, u, K0)[source]

Factor multivariate polynomials into irreducibles in \(QQ_I[X]\).

-sympy.polys.factortools.dmp_zz_i_factor(f, u, K0)[source]
+sympy.polys.factortools.dmp_zz_i_factor(f, u, K0)[source]

Factor multivariate polynomials into irreducibles in \(ZZ_I[X]\).

-sympy.polys.factortools.dup_ext_factor(f, K)[source]
+sympy.polys.factortools.dup_ext_factor(f, K)[source]

Factor univariate polynomials over algebraic number fields.

The domain \(K\) must be an algebraic number field \(k(a)\) (see QQ<a>).

Examples

@@ -5199,7 +5199,7 @@

Subresultant sequence
-sympy.polys.factortools.dmp_ext_factor(f, u, K)[source]
+sympy.polys.factortools.dmp_ext_factor(f, u, K)[source]

Factor multivariate polynomials over algebraic number fields.

The domain \(K\) must be an algebraic number field \(k(a)\) (see QQ<a>).

Examples

@@ -5243,50 +5243,50 @@

Subresultant sequence
-sympy.polys.factortools.dup_gf_factor(f, K)[source]
+sympy.polys.factortools.dup_gf_factor(f, K)[source]

Factor univariate polynomials over finite fields.

-sympy.polys.factortools.dmp_gf_factor(f, u, K)[source]
+sympy.polys.factortools.dmp_gf_factor(f, u, K)[source]

Factor multivariate polynomials over finite fields.

-sympy.polys.factortools.dup_factor_list(f, K0)[source]
+sympy.polys.factortools.dup_factor_list(f, K0)[source]

Factor univariate polynomials into irreducibles in \(K[x]\).

-sympy.polys.factortools.dup_factor_list_include(f, K)[source]
+sympy.polys.factortools.dup_factor_list_include(f, K)[source]

Factor univariate polynomials into irreducibles in \(K[x]\).

-sympy.polys.factortools.dmp_factor_list(f, u, K0)[source]
+sympy.polys.factortools.dmp_factor_list(f, u, K0)[source]

Factor multivariate polynomials into irreducibles in \(K[X]\).

-sympy.polys.factortools.dmp_factor_list_include(f, u, K)[source]
+sympy.polys.factortools.dmp_factor_list_include(f, u, K)[source]

Factor multivariate polynomials into irreducibles in \(K[X]\).

-sympy.polys.factortools.dup_irreducible_p(f, K)[source]
+sympy.polys.factortools.dup_irreducible_p(f, K)[source]

Returns True if a univariate polynomial f has no factors over its domain.

-sympy.polys.factortools.dmp_irreducible_p(f, u, K)[source]
+sympy.polys.factortools.dmp_irreducible_p(f, u, K)[source]

Returns True if a multivariate polynomial f has no factors over its domain.

@@ -5294,7 +5294,7 @@

Subresultant sequenceSquare-free factorization:

-sympy.polys.sqfreetools.dup_sqf_p(f, K)[source]
+sympy.polys.sqfreetools.dup_sqf_p(f, K)[source]

Return True if f is a square-free polynomial in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5311,7 +5311,7 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dmp_sqf_p(f, u, K)[source]
+sympy.polys.sqfreetools.dmp_sqf_p(f, u, K)[source]

Return True if f is a square-free polynomial in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5328,7 +5328,7 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dup_sqf_norm(f, K)[source]
+sympy.polys.sqfreetools.dup_sqf_norm(f, K)[source]

Find a shift of \(f\) in \(K[x]\) that has square-free norm.

The domain \(K\) must be an algebraic number field \(k(a)\) (see QQ<a>).

Returns \((s,g,r)\), such that \(g(x)=f(x-sa)\), \(r(x)=\text{Norm}(g(x))\) and @@ -5390,7 +5390,7 @@

Subresultant sequence
-sympy.polys.sqfreetools.dmp_sqf_norm(f, u, K)[source]
+sympy.polys.sqfreetools.dmp_sqf_norm(f, u, K)[source]

Find a shift of f in K[X] that has square-free norm.

The domain \(K\) must be an algebraic number field \(k(a)\) (see QQ<a>).

Returns \((s,g,r)\), such that \(g(x_1,x_2,\cdots)=f(x_1-s_1 a, x_2 - s_2 a, @@ -5453,7 +5453,7 @@

Subresultant sequence
-sympy.polys.sqfreetools.dmp_norm(f, u, K)[source]
+sympy.polys.sqfreetools.dmp_norm(f, u, K)[source]

Norm of f in K[X], often not square-free.

The domain \(K\) must be an algebraic number field \(k(a)\) (see QQ<a>).

Examples

@@ -5521,19 +5521,19 @@

Subresultant sequence
-sympy.polys.sqfreetools.dup_gf_sqf_part(f, K)[source]
+sympy.polys.sqfreetools.dup_gf_sqf_part(f, K)[source]

Compute square-free part of f in GF(p)[x].

-sympy.polys.sqfreetools.dmp_gf_sqf_part(f, u, K)[source]
+sympy.polys.sqfreetools.dmp_gf_sqf_part(f, u, K)[source]

Compute square-free part of f in GF(p)[X].

-sympy.polys.sqfreetools.dup_sqf_part(f, K)[source]
+sympy.polys.sqfreetools.dup_sqf_part(f, K)[source]

Returns square-free part of a polynomial in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5552,7 +5552,7 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dmp_sqf_part(f, u, K)[source]
+sympy.polys.sqfreetools.dmp_sqf_part(f, u, K)[source]

Returns square-free part of a polynomial in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5567,19 +5567,19 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dup_gf_sqf_list(f, K, all=False)[source]
+sympy.polys.sqfreetools.dup_gf_sqf_list(f, K, all=False)[source]

Compute square-free decomposition of f in GF(p)[x].

-sympy.polys.sqfreetools.dmp_gf_sqf_list(f, u, K, all=False)[source]
+sympy.polys.sqfreetools.dmp_gf_sqf_list(f, u, K, all=False)[source]

Compute square-free decomposition of f in GF(p)[X].

-sympy.polys.sqfreetools.dup_sqf_list(f, K, all=False)[source]
+sympy.polys.sqfreetools.dup_sqf_list(f, K, all=False)[source]

Return square-free decomposition of a polynomial in K[x].

Uses Yun’s algorithm from [Yun76].

Examples

@@ -5613,7 +5613,7 @@

Subresultant sequence
-sympy.polys.sqfreetools.dup_sqf_list_include(f, K, all=False)[source]
+sympy.polys.sqfreetools.dup_sqf_list_include(f, K, all=False)[source]

Return square-free decomposition of a polynomial in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5633,7 +5633,7 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dmp_sqf_list(f, u, K, all=False)[source]
+sympy.polys.sqfreetools.dmp_sqf_list(f, u, K, all=False)[source]

Return square-free decomposition of a polynomial in \(K[X]\).

Examples

>>> from sympy.polys import ring, ZZ
@@ -5671,7 +5671,7 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dmp_sqf_list_include(f, u, K, all=False)[source]
+sympy.polys.sqfreetools.dmp_sqf_list_include(f, u, K, all=False)[source]

Return square-free decomposition of a polynomial in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5691,7 +5691,7 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dup_gff_list(f, K)[source]
+sympy.polys.sqfreetools.dup_gff_list(f, K)[source]

Compute greatest factorial factorization of f in K[x].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5706,7 +5706,7 @@ 

Subresultant sequence
-sympy.polys.sqfreetools.dmp_gff_list(f, u, K)[source]
+sympy.polys.sqfreetools.dmp_gff_list(f, u, K)[source]

Compute greatest factorial factorization of f in K[X].

Examples

>>> from sympy.polys import ring, ZZ
@@ -5726,7 +5726,7 @@ 

Groebner basis algorithms
-sympy.polys.groebnertools.groebner(seq, ring, method=None)[source]
+sympy.polys.groebnertools.groebner(seq, ring, method=None)[source]

Computes Groebner basis for a set of polynomials in \(K[X]\).

Wrapper around the (default) improved Buchberger and the other algorithms for computing Groebner bases. The choice of algorithm can be changed via @@ -5736,14 +5736,14 @@

Groebner basis algorithms
-sympy.polys.groebnertools.spoly(p1, p2, ring)[source]
+sympy.polys.groebnertools.spoly(p1, p2, ring)[source]

Compute LCM(LM(p1), LM(p2))/LM(p1)*p1 - LCM(LM(p1), LM(p2))/LM(p2)*p2 This is the S-poly provided p1 and p2 are monic

-sympy.polys.groebnertools.red_groebner(G, ring)[source]
+sympy.polys.groebnertools.red_groebner(G, ring)[source]

Compute reduced Groebner basis, from BeckerWeispfenning93, p. 216

Selects a subset of generators, that already generate the ideal and computes a reduced Groebner basis for them.

@@ -5751,25 +5751,25 @@

Groebner basis algorithms
-sympy.polys.groebnertools.is_groebner(G, ring)[source]
+sympy.polys.groebnertools.is_groebner(G, ring)[source]

Check if G is a Groebner basis.

-sympy.polys.groebnertools.is_minimal(G, ring)[source]
+sympy.polys.groebnertools.is_minimal(G, ring)[source]

Checks if G is a minimal Groebner basis.

-sympy.polys.groebnertools.is_reduced(G, ring)[source]
+sympy.polys.groebnertools.is_reduced(G, ring)[source]

Checks if G is a reduced Groebner basis.

-sympy.polys.fglmtools.matrix_fglm(F, ring, O_to)[source]
+sympy.polys.fglmtools.matrix_fglm(F, ring, O_to)[source]

Converts the reduced Groebner basis F of a zero-dimensional ideal w.r.t. O_from to a reduced Groebner basis w.r.t. O_to.

@@ -5787,7 +5787,7 @@

Groebner basis algorithms
-sympy.polys.distributedmodules.sdm_spoly(f, g, O, K, phantom=None)[source]
+sympy.polys.distributedmodules.sdm_spoly(f, g, O, K, phantom=None)[source]

Compute the generalized s-polynomial of f and g.

The ground field is assumed to be K, and monomials ordered according to O.

@@ -5815,7 +5815,7 @@

Groebner basis algorithms
-sympy.polys.distributedmodules.sdm_ecart(f)[source]
+sympy.polys.distributedmodules.sdm_ecart(f)[source]

Compute the ecart of f.

This is defined to be the difference of the total degree of \(f\) and the total degree of the leading monomial of \(f\) [SCA, defn 2.3.7].

@@ -5832,7 +5832,7 @@

Groebner basis algorithms
-sympy.polys.distributedmodules.sdm_nf_mora(f, G, O, K, phantom=None)[source]
+sympy.polys.distributedmodules.sdm_nf_mora(f, G, O, K, phantom=None)[source]

Compute a weak normal form of f with respect to G and order O.

The ground field is assumed to be K, and monomials ordered according to O.

@@ -5854,7 +5854,7 @@

Groebner basis algorithms
-sympy.polys.distributedmodules.sdm_groebner(G, NF, O, K, extended=False)[source]
+sympy.polys.distributedmodules.sdm_groebner(G, NF, O, K, extended=False)[source]

Compute a minimal standard basis of G with respect to order O.

The algorithm uses a normal form NF, for example sdm_nf_mora. The ground field is assumed to be K, and monomials ordered according @@ -5883,7 +5883,7 @@

Groebner basis algorithmsPoly and public API functions.

-class sympy.polys.polyoptions.Options(gens, args, flags=None, strict=False)[source]
+class sympy.polys.polyoptions.Options(gens, args, flags=None, strict=False)[source]

Options manager for polynomial manipulation module.

Examples

>>> from sympy.polys.polyoptions import Options
@@ -5931,7 +5931,7 @@ 

Groebner basis algorithms
-clone(updates={})[source]
+clone(updates={})[source]

Clone self and update specified options.

@@ -5939,7 +5939,7 @@

Groebner basis algorithms
-sympy.polys.polyoptions.build_options(gens, args=None)[source]
+sympy.polys.polyoptions.build_options(gens, args=None)[source]

Construct options from keyword arguments or … options.

@@ -5949,7 +5949,7 @@

Groebner basis algorithms
-sympy.polys.polyconfig.setup(key, value=None)[source]
+sympy.polys.polyconfig.setup(key, value=None)[source]

Assign a value to (or reset) a configuration item.

@@ -5960,123 +5960,123 @@

Exceptions
-class sympy.polys.polyerrors.BasePolynomialError[source]
+class sympy.polys.polyerrors.BasePolynomialError[source]

Base class for polynomial related exceptions.

-class sympy.polys.polyerrors.ExactQuotientFailed(f, g, dom=None)[source]
+class sympy.polys.polyerrors.ExactQuotientFailed(f, g, dom=None)[source]
-class sympy.polys.polyerrors.OperationNotSupported(poly, func)[source]
+class sympy.polys.polyerrors.OperationNotSupported(poly, func)[source]
-class sympy.polys.polyerrors.HeuristicGCDFailed[source]
+class sympy.polys.polyerrors.HeuristicGCDFailed[source]
-class sympy.polys.polyerrors.HomomorphismFailed[source]
+class sympy.polys.polyerrors.HomomorphismFailed[source]
-class sympy.polys.polyerrors.IsomorphismFailed[source]
+class sympy.polys.polyerrors.IsomorphismFailed[source]
-class sympy.polys.polyerrors.ExtraneousFactors[source]
+class sympy.polys.polyerrors.ExtraneousFactors[source]
-class sympy.polys.polyerrors.EvaluationFailed[source]
+class sympy.polys.polyerrors.EvaluationFailed[source]
-class sympy.polys.polyerrors.RefinementFailed[source]
+class sympy.polys.polyerrors.RefinementFailed[source]
-class sympy.polys.polyerrors.CoercionFailed[source]
+class sympy.polys.polyerrors.CoercionFailed[source]
-class sympy.polys.polyerrors.NotInvertible[source]
+class sympy.polys.polyerrors.NotInvertible[source]
-class sympy.polys.polyerrors.NotReversible[source]
+class sympy.polys.polyerrors.NotReversible[source]
-class sympy.polys.polyerrors.NotAlgebraic[source]
+class sympy.polys.polyerrors.NotAlgebraic[source]
-class sympy.polys.polyerrors.DomainError[source]
+class sympy.polys.polyerrors.DomainError[source]
-class sympy.polys.polyerrors.PolynomialError[source]
+class sympy.polys.polyerrors.PolynomialError[source]
-class sympy.polys.polyerrors.UnificationFailed[source]
+class sympy.polys.polyerrors.UnificationFailed[source]
-class sympy.polys.polyerrors.GeneratorsNeeded[source]
+class sympy.polys.polyerrors.GeneratorsNeeded[source]
-class sympy.polys.polyerrors.ComputationFailed(func, nargs, exc)[source]
+class sympy.polys.polyerrors.ComputationFailed(func, nargs, exc)[source]
-class sympy.polys.polyerrors.GeneratorsError[source]
+class sympy.polys.polyerrors.GeneratorsError[source]
-class sympy.polys.polyerrors.UnivariatePolynomialError[source]
+class sympy.polys.polyerrors.UnivariatePolynomialError[source]
-class sympy.polys.polyerrors.MultivariatePolynomialError[source]
+class sympy.polys.polyerrors.MultivariatePolynomialError[source]
-class sympy.polys.polyerrors.PolificationFailed(opt, origs, exprs, seq=False)[source]
+class sympy.polys.polyerrors.PolificationFailed(opt, origs, exprs, seq=False)[source]
-class sympy.polys.polyerrors.OptionError[source]
+class sympy.polys.polyerrors.OptionError[source]
-class sympy.polys.polyerrors.FlagError[source]
+class sympy.polys.polyerrors.FlagError[source]
@@ -6086,7 +6086,7 @@

Reference

-sympy.polys.modulargcd.modgcd_univariate(f, g)[source]
+sympy.polys.modulargcd.modgcd_univariate(f, g)[source]

Computes the GCD of two polynomials in \(\mathbb{Z}[x]\) using a modular algorithm.

The algorithm computes the GCD of two univariate integer polynomials @@ -6166,7 +6166,7 @@

Modular GCD
-sympy.polys.modulargcd.modgcd_bivariate(f, g)[source]
+sympy.polys.modulargcd.modgcd_bivariate(f, g)[source]

Computes the GCD of two polynomials in \(\mathbb{Z}[x, y]\) using a modular algorithm.

The algorithm computes the GCD of two bivariate integer polynomials @@ -6252,7 +6252,7 @@

Modular GCD
-sympy.polys.modulargcd.modgcd_multivariate(f, g)[source]
+sympy.polys.modulargcd.modgcd_multivariate(f, g)[source]

Compute the GCD of two polynomials in \(\mathbb{Z}[x_0, \ldots, x_{k-1}]\) using a modular algorithm.

The algorithm computes the GCD of two multivariate integer polynomials @@ -6353,7 +6353,7 @@

Modular GCDcontbound,

-)[source] +)[source]

Compute the GCD of two polynomials in \(\mathbb{Z}_p[x_0, \ldots, x_{k-1}]\).

The algorithm reduces the problem step by step by evaluating the @@ -6410,7 +6410,7 @@

Modular GCD
-sympy.polys.modulargcd.func_field_modgcd(f, g)[source]
+sympy.polys.modulargcd.func_field_modgcd(f, g)[source]

Compute the GCD of two polynomials \(f\) and \(g\) in \(\mathbb Q(\alpha)[x_0, \ldots, x_{n-1}]\) using a modular algorithm.

The algorithm first computes the primitive associate diff --git a/dev/modules/polys/numberfields.html b/dev/modules/polys/numberfields.html index 8f6fac46a54..547f50e7811 100644 --- a/dev/modules/polys/numberfields.html +++ b/dev/modules/polys/numberfields.html @@ -926,7 +926,7 @@

Solving the Main Problems

-sympy.polys.numberfields.basis.round_two(T, radicals=None)[source]
+sympy.polys.numberfields.basis.round_two(T, radicals=None)[source]

Zassenhaus’s “Round 2” algorithm.

Parameters:
@@ -1028,7 +1028,7 @@

Prime Decompositionradical=None,

-)[source] +)[source]

Compute the decomposition of rational prime p in a number field.

Parameters:
@@ -1085,11 +1085,11 @@

Prime Decomposition
-class sympy.polys.numberfields.primes.PrimeIdeal(ZK, p, alpha, f, e=None)[source]
+class sympy.polys.numberfields.primes.PrimeIdeal(ZK, p, alpha, f, e=None)[source]

A prime ideal in a ring of algebraic integers.

-__init__(ZK, p, alpha, f, e=None)[source]
+__init__(ZK, p, alpha, f, e=None)[source]
Parameters:

ZK : Submodule

@@ -1119,7 +1119,7 @@

Prime Decomposition
-__add__(other)[source]
+__add__(other)[source]

Convert to a Submodule and add to another Submodule.

@@ -1130,7 +1130,7 @@

Prime Decomposition
-__mul__(other)[source]
+__mul__(other)[source]

Convert to a Submodule and multiply by another Submodule or a rational number.

@@ -1141,7 +1141,7 @@

Prime Decomposition
-as_submodule()[source]
+as_submodule()[source]

Represent this prime ideal as a Submodule.

Returns:
@@ -1197,7 +1197,7 @@

Prime Decomposition
-reduce_ANP(a)[source]
+reduce_ANP(a)[source]

Reduce an ANP to a “small representative” modulo this prime ideal.

@@ -1222,7 +1222,7 @@

Prime Decomposition
-reduce_alg_num(a)[source]
+reduce_alg_num(a)[source]

Reduce an AlgebraicNumber to a “small representative” modulo this prime ideal.

@@ -1247,7 +1247,7 @@

Prime Decomposition
-reduce_element(elt)[source]
+reduce_element(elt)[source]

Reduce a PowerBasisElement to a “small representative” modulo this prime ideal.

@@ -1272,7 +1272,7 @@

Prime Decomposition
-repr(field_gen=None, just_gens=False)[source]
+repr(field_gen=None, just_gens=False)[source]

Print a representation of this prime ideal.

Parameters:
@@ -1309,7 +1309,7 @@

Prime Decomposition
-test_factor()[source]
+test_factor()[source]

Compute a test factor for this prime ideal.

Explanation

Write \(\mathfrak{p}\) for this prime ideal, \(p\) for the rational prime @@ -1323,7 +1323,7 @@

Prime Decomposition
-valuation(I)[source]
+valuation(I)[source]

Compute the \(\mathfrak{p}\)-adic valuation of integral ideal I at this prime ideal.

@@ -1344,7 +1344,7 @@

Prime Decomposition

-sympy.polys.numberfields.primes.prime_valuation(I, P)[source]
+sympy.polys.numberfields.primes.prime_valuation(I, P)[source]

Compute the P-adic valuation for an integral ideal I.

Parameters:
@@ -1401,7 +1401,7 @@

Galois Groups**args,

-)[source] +)[source]

Compute the Galois group for polynomials f up to degree 6.

Parameters:
@@ -1521,7 +1521,7 @@

Finding Minimal Polynomialsdomain=None,

-)[source] +)[source]

Computes the minimal polynomial of an algebraic element.

Parameters:
@@ -1587,7 +1587,7 @@

Finding Minimal Polynomialsdomain=None,

-)[source] +)[source]

This is a synonym for minimal_polynomial().

@@ -1625,7 +1625,7 @@

The Subfield Problem
-sympy.polys.numberfields.subfield.field_isomorphism(a, b, *, fast=True)[source]
+sympy.polys.numberfields.subfield.field_isomorphism(a, b, *, fast=True)[source]

Find an embedding of one number field into another.

Parameters:
@@ -1682,7 +1682,7 @@

The Subfield Problempolys=False,

-)[source] +)[source]

Find a single generator for a number field given by several generators.

Parameters:
@@ -1777,7 +1777,7 @@

The Subfield Problemalias=None,

-)[source] +)[source]

Express one algebraic number in the field generated by another.

Parameters:
@@ -2062,7 +2062,7 @@

Module HomomorphismsClass Reference

-class sympy.polys.numberfields.modules.Module[source]
+class sympy.polys.numberfields.modules.Module[source]

Generic finitely-generated module.

This is an abstract base class, and should not be instantiated directly. The two concrete subclasses are PowerBasis and @@ -2075,7 +2075,7 @@

Class ReferencePowerBasis.

-__call__(spec, denom=1)[source]
+__call__(spec, denom=1)[source]

Generate a ModuleElement belonging to this module.

Parameters:
@@ -2119,7 +2119,7 @@

Class Reference
-ancestors(include_self=False)[source]
+ancestors(include_self=False)[source]

Return the list of ancestor modules of this module, from the foundational PowerBasis downward, optionally including self.

@@ -2131,14 +2131,14 @@

Class Reference
-basis_elements()[source]
+basis_elements()[source]

Get list of ModuleElement being the generators of this module.

-element_from_rational(a)[source]
+element_from_rational(a)[source]

Return a ModuleElement representing a rational number.

Parameters:
@@ -2166,19 +2166,19 @@

Class Reference
-endomorphism_ring()[source]
+endomorphism_ring()[source]

Form the EndomorphismRing for this module.

-is_compat_col(col)[source]
+is_compat_col(col)[source]

Say whether col is a suitable column vector for this module.

-mult_tab()[source]
+mult_tab()[source]

Get the multiplication table for this module (if closed under mult).

Returns:
@@ -2221,7 +2221,7 @@

Class Reference
-nearest_common_ancestor(other)[source]
+nearest_common_ancestor(other)[source]

Locate the nearest common ancestor of this module and another.

Returns:
@@ -2253,7 +2253,7 @@

Class Reference
-one()[source]
+one()[source]

Return a ModuleElement representing unity, and belonging to the first ancestor of this module (including itself) that starts with unity.

@@ -2279,7 +2279,7 @@

Class Reference
-power_basis_ancestor()[source]
+power_basis_ancestor()[source]

Return the PowerBasis that is an ancestor of this module.

See also

@@ -2289,7 +2289,7 @@

Class Reference
-represent(elt)[source]
+represent(elt)[source]

Represent a module element as an integer-linear combination over the generators of this module.

@@ -2370,7 +2370,7 @@

Class Reference
-starts_with_unity()[source]
+starts_with_unity()[source]

Say whether the module’s first generator equals unity.

@@ -2384,7 +2384,7 @@

Class Referencehnf_modulus=None,

-)[source] +)[source]

Form the submodule generated by a list of ModuleElement belonging to this module.

@@ -2424,7 +2424,7 @@

Class Reference
-submodule_from_matrix(B, denom=1)[source]
+submodule_from_matrix(B, denom=1)[source]

Form the submodule generated by the elements of this module indicated by the columns of a matrix, with an optional denominator.

@@ -2473,7 +2473,7 @@

Class Reference
-whole_submodule()[source]
+whole_submodule()[source]

Return a submodule equal to this entire module.

Explanation

This is useful when you have a PowerBasis and want to @@ -2483,7 +2483,7 @@

Class Reference
-zero()[source]
+zero()[source]

Return a ModuleElement representing zero.

@@ -2491,11 +2491,11 @@

Class Reference
-class sympy.polys.numberfields.modules.PowerBasis(T)[source]
+class sympy.polys.numberfields.modules.PowerBasis(T)[source]

The module generated by the powers of an algebraic integer.

-__init__(T)[source]
+__init__(T)[source]
Parameters:

T : Poly, AlgebraicField

@@ -2511,19 +2511,19 @@

Class Reference
-element_from_ANP(a)[source]
+element_from_ANP(a)[source]

Convert an ANP into a PowerBasisElement.

-element_from_alg_num(a)[source]
+element_from_alg_num(a)[source]

Convert an AlgebraicNumber into a PowerBasisElement.

-element_from_poly(f)[source]
+element_from_poly(f)[source]

Produce an element of this module, representing f after reduction mod our defining minimal polynomial.

@@ -2538,7 +2538,7 @@

Class Reference
-represent(elt)[source]
+represent(elt)[source]

Represent a module element as an integer-linear combination over the generators of this module.

@@ -2551,7 +2551,7 @@

Class Reference
-class sympy.polys.numberfields.modules.Submodule(parent, matrix, denom=1, mult_tab=None)[source]
+class sympy.polys.numberfields.modules.Submodule(parent, matrix, denom=1, mult_tab=None)[source]

A submodule of another module.

@@ -2564,7 +2564,7 @@

Class Referencemult_tab=None,

-)[source] +)[source]
Parameters:

parent : Module

@@ -2621,7 +2621,7 @@

Class Reference
-add(other, hnf=True, hnf_modulus=None)[source]
+add(other, hnf=True, hnf_modulus=None)[source]

Add this Submodule to another.

Parameters:
@@ -2649,21 +2649,21 @@

Class Reference
-basis_element_pullbacks()[source]
+basis_element_pullbacks()[source]

Return list of this submodule’s basis elements as elements of the submodule’s parent module.

-discard_before(r)[source]
+discard_before(r)[source]

Produce a new module by discarding all generators before a given index r.

-mul(other, hnf=True, hnf_modulus=None)[source]
+mul(other, hnf=True, hnf_modulus=None)[source]

Multiply this Submodule by a rational number, a ModuleElement, or another Submodule.

@@ -2696,7 +2696,7 @@

Class Reference
-reduce_element(elt)[source]
+reduce_element(elt)[source]

If this submodule \(B\) has defining matrix \(W\) in square, maximal-rank Hermite normal form, then, given an element \(x\) of the parent module \(A\), we produce an element \(y \in A\) such that \(x - y \in B\), and the @@ -2759,7 +2759,7 @@

Class Reference
-reduced()[source]
+reduced()[source]

Produce a reduced version of this submodule.

Returns:
@@ -2774,7 +2774,7 @@

Class Reference
-represent(elt)[source]
+represent(elt)[source]

Represent a module element as an integer-linear combination over the generators of this module.

@@ -2787,14 +2787,14 @@

Class Reference
-class sympy.polys.numberfields.modules.ModuleElement(module, col, denom=1)[source]
+class sympy.polys.numberfields.modules.ModuleElement(module, col, denom=1)[source]

Represents an element of a Module.

NOTE: Should not be constructed directly. Use the __call__() method or the make_mod_elt() factory function instead.

-__init__(module, col, denom=1)[source]
+__init__(module, col, denom=1)[source]
Parameters:

module : Module

@@ -2816,7 +2816,7 @@

Class Reference
-__add__(other)[source]
+__add__(other)[source]

A ModuleElement can be added to a rational number, or to another ModuleElement.

Explanation

@@ -2830,7 +2830,7 @@

Class Reference
-__mul__(other)[source]
+__mul__(other)[source]

A ModuleElement can be multiplied by a rational number, or by another ModuleElement.

Explanation

@@ -2846,7 +2846,7 @@

Class Reference
-__mod__(m)[source]
+__mod__(m)[source]

Reduce this ModuleElement mod a Submodule.

Parameters:
@@ -2877,13 +2877,13 @@

Class Reference
-column(domain=None)[source]
+column(domain=None)[source]

Get a copy of this element’s column, optionally converting to a domain.

-equiv(other)[source]
+equiv(other)[source]

A ModuleElement may test as equivalent to a rational number or another ModuleElement, if they represent the same algebraic number.

@@ -2921,14 +2921,14 @@

Class Referencedenom=1,

-)[source] +)[source]

Make a ModuleElement from a list of ints (instead of a column vector).

-is_compat(other)[source]
+is_compat(other)[source]

Test whether other is another ModuleElement with same module.

@@ -2941,28 +2941,28 @@

Class Reference
-over_power_basis()[source]
+over_power_basis()[source]

Transform into a PowerBasisElement over our PowerBasis ancestor.

-reduced()[source]
+reduced()[source]

Produce a reduced version of this ModuleElement, i.e. one in which the gcd of the denominator together with all numerator coefficients is 1.

-reduced_mod_p(p)[source]
+reduced_mod_p(p)[source]

Produce a version of this ModuleElement in which all numerator coefficients have been reduced mod p.

-to_ancestor(anc)[source]
+to_ancestor(anc)[source]

Transform into a ModuleElement belonging to a given ancestor of this element’s module.

@@ -2974,14 +2974,14 @@

Class Reference
-to_parent()[source]
+to_parent()[source]

Transform into a ModuleElement belonging to the parent of this element’s module.

-unify(other)[source]
+unify(other)[source]

Try to make a compatible pair of ModuleElement, one equivalent to this one, and one equivalent to the other.

@@ -3009,7 +3009,7 @@

Class Reference
-class sympy.polys.numberfields.modules.PowerBasisElement(module, col, denom=1)[source]
+class sympy.polys.numberfields.modules.PowerBasisElement(module, col, denom=1)[source]

Subclass for ModuleElement instances whose module is a PowerBasis.

@@ -3020,7 +3020,7 @@

Class Reference
-as_expr(x=None)[source]
+as_expr(x=None)[source]

Create a Basic expression from self.

@@ -3042,31 +3042,31 @@

Class Reference
-norm(T=None)[source]
+norm(T=None)[source]

Compute the norm of this number.

-numerator(x=None)[source]
+numerator(x=None)[source]

Obtain the numerator as a polynomial over ZZ.

-poly(x=None)[source]
+poly(x=None)[source]

Obtain the number as a polynomial over QQ.

-to_ANP()[source]
+to_ANP()[source]

Convert to an equivalent ANP.

-to_alg_num()[source]
+to_alg_num()[source]

Try to convert to an equivalent AlgebraicNumber.

Returns:
@@ -3095,7 +3095,7 @@

Class Reference
-sympy.polys.numberfields.modules.make_mod_elt(module, col, denom=1)[source]
+sympy.polys.numberfields.modules.make_mod_elt(module, col, denom=1)[source]

Factory function which builds a ModuleElement, but ensures that it is a PowerBasisElement if the module is a PowerBasis.

@@ -3103,7 +3103,7 @@

Class Reference
-class sympy.polys.numberfields.modules.ModuleHomomorphism(domain, codomain, mapping)[source]
+class sympy.polys.numberfields.modules.ModuleHomomorphism(domain, codomain, mapping)[source]

A homomorphism from one module to another.

@@ -3115,7 +3115,7 @@

Class Referencemapping,

-)[source] +)[source]
Parameters:

domain : Module

@@ -3149,7 +3149,7 @@

Class Reference
-kernel(modulus=None)[source]
+kernel(modulus=None)[source]

Compute a Submodule representing the kernel of this homomorphism.

Parameters:
@@ -3172,7 +3172,7 @@

Class Reference
-matrix(modulus=None)[source]
+matrix(modulus=None)[source]

Compute the matrix of this homomorphism.

Parameters:
@@ -3196,11 +3196,11 @@

Class Reference
-class sympy.polys.numberfields.modules.ModuleEndomorphism(domain, mapping)[source]
+class sympy.polys.numberfields.modules.ModuleEndomorphism(domain, mapping)[source]

A homomorphism from one module to itself.

-__init__(domain, mapping)[source]
+__init__(domain, mapping)[source]
Parameters:

domain : Module

@@ -3221,12 +3221,12 @@

Class Reference
-class sympy.polys.numberfields.modules.InnerEndomorphism(domain, multiplier)[source]
+class sympy.polys.numberfields.modules.InnerEndomorphism(domain, multiplier)[source]

An inner endomorphism on a module, i.e. the endomorphism corresponding to multiplication by a fixed element.

-__init__(domain, multiplier)[source]
+__init__(domain, multiplier)[source]
Parameters:

domain : Module

@@ -3245,11 +3245,11 @@

Class Reference
-class sympy.polys.numberfields.modules.EndomorphismRing(domain)[source]
+class sympy.polys.numberfields.modules.EndomorphismRing(domain)[source]

The ring of endomorphisms on a module.

-__init__(domain)[source]
+__init__(domain)[source]
Parameters:

domain : Module

@@ -3262,7 +3262,7 @@

Class Reference
-inner_endomorphism(multiplier)[source]
+inner_endomorphism(multiplier)[source]

Form an inner endomorphism belonging to this endomorphism ring.

Parameters:
@@ -3279,7 +3279,7 @@

Class Reference
-represent(element)[source]
+represent(element)[source]

Represent an element of this endomorphism ring, as a single column vector.

@@ -3361,7 +3361,7 @@

Class Reference
-sympy.polys.numberfields.modules.find_min_poly(alpha, domain, x=None, powers=None)[source]
+sympy.polys.numberfields.modules.find_min_poly(alpha, domain, x=None, powers=None)[source]

Find a polynomial of least degree (not necessarily irreducible) satisfied by an element of a finitely-generated ring with unity.

@@ -3437,7 +3437,7 @@

Class Reference

-sympy.polys.numberfields.utilities.is_rat(c)[source]
+sympy.polys.numberfields.utilities.is_rat(c)[source]

Test whether an argument is of an acceptable type to be used as a rational number.

Explanation

@@ -3450,7 +3450,7 @@

Utilities
-sympy.polys.numberfields.utilities.is_int(c)[source]
+sympy.polys.numberfields.utilities.is_int(c)[source]

Test whether an argument is of an acceptable type to be used as an integer.

Explanation

Returns True on any argument of type int or ZZ.

@@ -3462,7 +3462,7 @@

Utilities
-sympy.polys.numberfields.utilities.get_num_denom(c)[source]
+sympy.polys.numberfields.utilities.get_num_denom(c)[source]

Given any argument on which is_rat() is True, return the numerator and denominator of this number.

@@ -3473,7 +3473,7 @@

Utilities
-sympy.polys.numberfields.utilities.extract_fundamental_discriminant(a)[source]
+sympy.polys.numberfields.utilities.extract_fundamental_discriminant(a)[source]

Extract a fundamental discriminant from an integer a.

Parameters:
@@ -3522,7 +3522,7 @@

Utilities
-class sympy.polys.numberfields.utilities.AlgIntPowers(T, modulus=None)[source]
+class sympy.polys.numberfields.utilities.AlgIntPowers(T, modulus=None)[source]

Compute the powers of an algebraic integer.

Explanation

Given an algebraic integer \(\theta\) by its monic irreducible polynomial @@ -3556,7 +3556,7 @@

Utilities
-__init__(T, modulus=None)[source]
+__init__(T, modulus=None)[source]
Parameters:

T : Poly

@@ -3576,7 +3576,7 @@

Utilities +sympy.polys.numberfields.utilities.coeff_search(m, R)[source]

Generate coefficients for searching through polynomials.

Parameters:
@@ -3613,7 +3613,7 @@

Utilities
-sympy.polys.numberfields.utilities.supplement_a_subspace(M)[source]
+sympy.polys.numberfields.utilities.supplement_a_subspace(M)[source]

Extend a basis for a subspace to a basis for the whole space.

Parameters:
@@ -3679,7 +3679,7 @@

Utilities
-sympy.polys.numberfields.utilities.isolate(alg, eps=None, fast=False)[source]
+sympy.polys.numberfields.utilities.isolate(alg, eps=None, fast=False)[source]

Find a rational isolating interval for a real algebraic number.

Parameters:
diff --git a/dev/modules/polys/reference.html b/dev/modules/polys/reference.html index 3007001d978..f3352808b49 100644 --- a/dev/modules/polys/reference.html +++ b/dev/modules/polys/reference.html @@ -810,7 +810,7 @@
Documentation Version

Basic polynomial manipulation functions

-sympy.polys.polytools.poly(expr, *gens, **args)[source]
+sympy.polys.polytools.poly(expr, *gens, **args)[source]

Efficiently transform an expression into a polynomial.

Examples

>>> from sympy import poly
@@ -825,19 +825,19 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.poly_from_expr(expr, *gens, **args)[source]
+sympy.polys.polytools.poly_from_expr(expr, *gens, **args)[source]

Construct a polynomial from an expression.

-sympy.polys.polytools.parallel_poly_from_expr(exprs, *gens, **args)[source]
+sympy.polys.polytools.parallel_poly_from_expr(exprs, *gens, **args)[source]

Construct polynomials from expressions.

-sympy.polys.polytools.degree(f, gen=0)[source]
+sympy.polys.polytools.degree(f, gen=0)[source]

Return the degree of f in the given variable.

The degree of 0 is negative infinity.

Examples

@@ -861,7 +861,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.degree_list(f, *gens, **args)[source]
+sympy.polys.polytools.degree_list(f, *gens, **args)[source]

Return a list of degrees of f in all variables.

Examples

>>> from sympy import degree_list
@@ -876,7 +876,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.LC(f, *gens, **args)[source]
+sympy.polys.polytools.LC(f, *gens, **args)[source]

Return the leading coefficient of f.

Examples

>>> from sympy import LC
@@ -891,7 +891,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.LM(f, *gens, **args)[source]
+sympy.polys.polytools.LM(f, *gens, **args)[source]

Return the leading monomial of f.

Examples

>>> from sympy import LM
@@ -906,7 +906,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.LT(f, *gens, **args)[source]
+sympy.polys.polytools.LT(f, *gens, **args)[source]

Return the leading term of f.

Examples

>>> from sympy import LT
@@ -921,7 +921,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.pdiv(f, g, *gens, **args)[source]
+sympy.polys.polytools.pdiv(f, g, *gens, **args)[source]

Compute polynomial pseudo-division of f and g.

Examples

>>> from sympy import pdiv
@@ -936,7 +936,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.prem(f, g, *gens, **args)[source]
+sympy.polys.polytools.prem(f, g, *gens, **args)[source]

Compute polynomial pseudo-remainder of f and g.

Examples

>>> from sympy import prem
@@ -951,7 +951,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.pquo(f, g, *gens, **args)[source]
+sympy.polys.polytools.pquo(f, g, *gens, **args)[source]

Compute polynomial pseudo-quotient of f and g.

Examples

>>> from sympy import pquo
@@ -968,7 +968,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.pexquo(f, g, *gens, **args)[source]
+sympy.polys.polytools.pexquo(f, g, *gens, **args)[source]

Compute polynomial exact pseudo-quotient of f and g.

Examples

>>> from sympy import pexquo
@@ -989,7 +989,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.div(f, g, *gens, **args)[source]
+sympy.polys.polytools.div(f, g, *gens, **args)[source]

Compute polynomial division of f and g.

Examples

>>> from sympy import div, ZZ, QQ
@@ -1006,7 +1006,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.rem(f, g, *gens, **args)[source]
+sympy.polys.polytools.rem(f, g, *gens, **args)[source]

Compute polynomial remainder of f and g.

Examples

>>> from sympy import rem, ZZ, QQ
@@ -1023,7 +1023,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.quo(f, g, *gens, **args)[source]
+sympy.polys.polytools.quo(f, g, *gens, **args)[source]

Compute polynomial quotient of f and g.

Examples

>>> from sympy import quo
@@ -1040,7 +1040,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.exquo(f, g, *gens, **args)[source]
+sympy.polys.polytools.exquo(f, g, *gens, **args)[source]

Compute polynomial exact quotient of f and g.

Examples

>>> from sympy import exquo
@@ -1061,7 +1061,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.half_gcdex(f, g, *gens, **args)[source]
+sympy.polys.polytools.half_gcdex(f, g, *gens, **args)[source]

Half extended Euclidean algorithm of f and g.

Returns (s, h) such that h = gcd(f, g) and s*f = h (mod g).

Examples

@@ -1077,7 +1077,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.gcdex(f, g, *gens, **args)[source]
+sympy.polys.polytools.gcdex(f, g, *gens, **args)[source]

Extended Euclidean algorithm of f and g.

Returns (s, t, h) such that h = gcd(f, g) and s*f + t*g = h.

Examples

@@ -1093,7 +1093,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.invert(f, g, *gens, **args)[source]
+sympy.polys.polytools.invert(f, g, *gens, **args)[source]

Invert f modulo g when possible.

Examples

>>> from sympy import invert, S, mod_inverse
@@ -1126,7 +1126,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.subresultants(f, g, *gens, **args)[source]
+sympy.polys.polytools.subresultants(f, g, *gens, **args)[source]

Compute subresultant PRS of f and g.

Examples

>>> from sympy import subresultants
@@ -1141,7 +1141,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.resultant(f, g, *gens, includePRS=False, **args)[source]
+sympy.polys.polytools.resultant(f, g, *gens, includePRS=False, **args)[source]

Compute resultant of f and g.

Examples

>>> from sympy import resultant
@@ -1156,7 +1156,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.discriminant(f, *gens, **args)[source]
+sympy.polys.polytools.discriminant(f, *gens, **args)[source]

Compute discriminant of f.

Examples

>>> from sympy import discriminant
@@ -1171,7 +1171,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.terms_gcd(f, *gens, **args)[source]
+sympy.polys.polytools.terms_gcd(f, *gens, **args)[source]

Remove GCD of terms from f.

If the deep flag is True, then the arguments of f will have terms_gcd applied to them.

@@ -1234,7 +1234,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.cofactors(f, g, *gens, **args)[source]
+sympy.polys.polytools.cofactors(f, g, *gens, **args)[source]

Compute GCD and cofactors of f and g.

Returns polynomials (h, cff, cfg) such that h = gcd(f, g), and cff = quo(f, h) and cfg = quo(g, h) are, so called, cofactors @@ -1252,7 +1252,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.gcd(f, g=None, *gens, **args)[source]
+sympy.polys.polytools.gcd(f, g=None, *gens, **args)[source]

Compute GCD of f and g.

Examples

>>> from sympy import gcd
@@ -1267,7 +1267,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.gcd_list(seq, *gens, **args)[source]
+sympy.polys.polytools.gcd_list(seq, *gens, **args)[source]

Compute GCD of a list of polynomials.

Examples

>>> from sympy import gcd_list
@@ -1282,7 +1282,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.lcm(f, g=None, *gens, **args)[source]
+sympy.polys.polytools.lcm(f, g=None, *gens, **args)[source]

Compute LCM of f and g.

Examples

>>> from sympy import lcm
@@ -1297,7 +1297,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.lcm_list(seq, *gens, **args)[source]
+sympy.polys.polytools.lcm_list(seq, *gens, **args)[source]

Compute LCM of a list of polynomials.

Examples

>>> from sympy import lcm_list
@@ -1312,7 +1312,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.trunc(f, p, *gens, **args)[source]
+sympy.polys.polytools.trunc(f, p, *gens, **args)[source]

Reduce f modulo a constant p.

Examples

>>> from sympy import trunc
@@ -1327,7 +1327,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.monic(f, *gens, **args)[source]
+sympy.polys.polytools.monic(f, *gens, **args)[source]

Divide all coefficients of f by LC(f).

Examples

>>> from sympy import monic
@@ -1342,7 +1342,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.content(f, *gens, **args)[source]
+sympy.polys.polytools.content(f, *gens, **args)[source]

Compute GCD of coefficients of f.

Examples

>>> from sympy import content
@@ -1357,7 +1357,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.primitive(f, *gens, **args)[source]
+sympy.polys.polytools.primitive(f, *gens, **args)[source]

Compute content and the primitive form of f.

Examples

>>> from sympy.polys.polytools import primitive
@@ -1391,7 +1391,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.compose(f, g, *gens, **args)[source]
+sympy.polys.polytools.compose(f, g, *gens, **args)[source]

Compute functional composition f(g).

Examples

>>> from sympy import compose
@@ -1406,7 +1406,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.decompose(f, *gens, **args)[source]
+sympy.polys.polytools.decompose(f, *gens, **args)[source]

Compute functional decomposition of f.

Examples

>>> from sympy import decompose
@@ -1421,7 +1421,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.sturm(f, *gens, **args)[source]
+sympy.polys.polytools.sturm(f, *gens, **args)[source]

Compute Sturm sequence of f.

Examples

>>> from sympy import sturm
@@ -1436,7 +1436,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.gff_list(f, *gens, **args)[source]
+sympy.polys.polytools.gff_list(f, *gens, **args)[source]

Compute a list of greatest factorial factors of f.

Note that the input to ff() and rf() should be Poly instances to use the definitions here.

@@ -1471,13 +1471,13 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.gff(f, *gens, **args)[source]
+sympy.polys.polytools.gff(f, *gens, **args)[source]

Compute greatest factorial factorization of f.

-sympy.polys.polytools.sqf_norm(f, *gens, **args)[source]
+sympy.polys.polytools.sqf_norm(f, *gens, **args)[source]

Compute square-free norm of f.

Returns s, f, r, such that g(x) = f(x-sa) and r(x) = Norm(g(x)) is a square-free polynomial over K, @@ -1495,7 +1495,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.sqf_part(f, *gens, **args)[source]
+sympy.polys.polytools.sqf_part(f, *gens, **args)[source]

Compute square-free part of f.

Examples

>>> from sympy import sqf_part
@@ -1510,7 +1510,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.sqf_list(f, *gens, **args)[source]
+sympy.polys.polytools.sqf_list(f, *gens, **args)[source]

Compute a list of square-free factors of f.

Examples

>>> from sympy import sqf_list
@@ -1525,7 +1525,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.sqf(f, *gens, **args)[source]
+sympy.polys.polytools.sqf(f, *gens, **args)[source]

Compute square-free factorization of f.

Examples

>>> from sympy import sqf
@@ -1540,7 +1540,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.factor_list(f, *gens, **args)[source]
+sympy.polys.polytools.factor_list(f, *gens, **args)[source]

Compute a list of irreducible factors of f.

Examples

>>> from sympy import factor_list
@@ -1555,7 +1555,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.factor(f, *gens, deep=False, **args)[source]
+sympy.polys.polytools.factor(f, *gens, deep=False, **args)[source]

Compute the factorization of expression, f, into irreducibles. (To factor an integer into primes, use factorint.)

There two modes implemented: symbolic and formal. If f is not an @@ -1636,7 +1636,7 @@

Basic polynomial manipulation functionssqf=False,

-)[source] +)[source]

Compute isolating intervals for roots of f.

Examples

>>> from sympy import intervals
@@ -1665,7 +1665,7 @@ 

Basic polynomial manipulation functionscheck_sqf=False,

-)[source] +)[source]

Refine an isolating interval of a root to the given precision.

Examples

>>> from sympy import refine_root
@@ -1680,7 +1680,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.count_roots(f, inf=None, sup=None)[source]
+sympy.polys.polytools.count_roots(f, inf=None, sup=None)[source]

Return the number of roots of f in [inf, sup] interval.

If one of inf or sup is complex, it will return the number of roots in the complex rectangle with corners at inf and sup.

@@ -1708,7 +1708,7 @@

Basic polynomial manipulation functionsextension=False,

-)[source] +)[source]

Returns the real and complex roots of f with multiplicities.

Parameters:
@@ -1866,7 +1866,7 @@

Basic polynomial manipulation functionsextension=False,

-)[source] +)[source]

Returns the real roots of f with multiplicities.

Parameters:
@@ -2037,7 +2037,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.nroots(f, n=15, maxsteps=50, cleanup=True)[source]
+sympy.polys.polytools.nroots(f, n=15, maxsteps=50, cleanup=True)[source]

Compute numerical approximations of roots of f.

Examples

>>> from sympy import nroots
@@ -2054,7 +2054,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.ground_roots(f, *gens, **args)[source]
+sympy.polys.polytools.ground_roots(f, *gens, **args)[source]

Compute roots of f by factorization in the ground domain.

Examples

>>> from sympy import ground_roots
@@ -2069,7 +2069,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.nth_power_roots_poly(f, n, *gens, **args)[source]
+sympy.polys.polytools.nth_power_roots_poly(f, n, *gens, **args)[source]

Construct a polynomial with n-th powers of roots of f.

Examples

>>> from sympy import nth_power_roots_poly, factor, roots
@@ -2096,7 +2096,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.cancel(f, *gens, _signsimp=True, **args)[source]
+sympy.polys.polytools.cancel(f, *gens, _signsimp=True, **args)[source]

Cancel common factors in a rational function f.

Examples

>>> from sympy import cancel, sqrt, Symbol, together
@@ -2122,7 +2122,7 @@ 

Basic polynomial manipulation functions
-sympy.polys.polytools.reduced(f, G, *gens, **args)[source]
+sympy.polys.polytools.reduced(f, G, *gens, **args)[source]

Reduces a polynomial f modulo a set of polynomials G.

Given a polynomial f and a set of polynomials G = (g_1, ..., g_n), computes a set of quotients q = (q_1, ..., q_n) and the remainder r @@ -2141,7 +2141,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.groebner(F, *gens, **args)[source]
+sympy.polys.polytools.groebner(F, *gens, **args)[source]

Computes the reduced Groebner basis for a set of polynomials.

Use the order argument to set the monomial ordering that will be used to compute the basis. Allowed orders are lex, grlex and @@ -2190,7 +2190,7 @@

Basic polynomial manipulation functions
-sympy.polys.polytools.is_zero_dimensional(F, *gens, **args)[source]
+sympy.polys.polytools.is_zero_dimensional(F, *gens, **args)[source]

Checks if the ideal generated by a Groebner basis is zero-dimensional.

The algorithm checks if the set of monomials not divisible by the leading monomial of any element of F is bounded.

@@ -2201,7 +2201,7 @@

Basic polynomial manipulation functions
-class sympy.polys.polytools.Poly(rep, *gens, **args)[source]
+class sympy.polys.polytools.Poly(rep, *gens, **args)[source]

Generic class for representing and operating on polynomial expressions.

See Polynomial Manipulation for general documentation.

Poly is a subclass of Basic rather than Expr but instances can be @@ -2248,7 +2248,7 @@

Basic polynomial manipulation functions
-EC(order=None)[source]
+EC(order=None)[source]

Returns the last non-zero coefficient of f.

Examples

>>> from sympy import Poly
@@ -2263,7 +2263,7 @@ 

Basic polynomial manipulation functions
-EM(order=None)[source]
+EM(order=None)[source]

Returns the last non-zero monomial of f.

Examples

>>> from sympy import Poly
@@ -2278,7 +2278,7 @@ 

Basic polynomial manipulation functions
-ET(order=None)[source]
+ET(order=None)[source]

Returns the last non-zero term of f.

Examples

>>> from sympy import Poly
@@ -2293,7 +2293,7 @@ 

Basic polynomial manipulation functions
-LC(order=None)[source]
+LC(order=None)[source]

Returns the leading coefficient of f.

Examples

>>> from sympy import Poly
@@ -2308,7 +2308,7 @@ 

Basic polynomial manipulation functions
-LM(order=None)[source]
+LM(order=None)[source]

Returns the leading monomial of f.

The Leading monomial signifies the monomial having the highest power of the principal generator in the @@ -2326,7 +2326,7 @@

Basic polynomial manipulation functions
-LT(order=None)[source]
+LT(order=None)[source]

Returns the leading term of f.

The Leading term signifies the term having the highest power of the principal generator in the @@ -2344,7 +2344,7 @@

Basic polynomial manipulation functions
-TC()[source]
+TC()[source]

Returns the trailing coefficient of f.

Examples

>>> from sympy import Poly
@@ -2359,7 +2359,7 @@ 

Basic polynomial manipulation functions
-abs()[source]
+abs()[source]

Make all coefficients in f positive.

Examples

>>> from sympy import Poly
@@ -2374,7 +2374,7 @@ 

Basic polynomial manipulation functions
-add(g)[source]
+add(g)[source]

Add two polynomials f and g.

Examples

>>> from sympy import Poly
@@ -2393,7 +2393,7 @@ 

Basic polynomial manipulation functions
-add_ground(coeff)[source]
+add_ground(coeff)[source]

Add an element of the ground domain to f.

Examples

>>> from sympy import Poly
@@ -2408,7 +2408,7 @@ 

Basic polynomial manipulation functions
-all_coeffs()[source]
+all_coeffs()[source]

Returns all coefficients from a univariate polynomial f.

Examples

>>> from sympy import Poly
@@ -2423,7 +2423,7 @@ 

Basic polynomial manipulation functions
-all_monoms()[source]
+all_monoms()[source]

Returns all monomials from a univariate polynomial f.

Examples

>>> from sympy import Poly
@@ -2442,7 +2442,7 @@ 

Basic polynomial manipulation functions
-all_roots(multiple=True, radicals=True)[source]
+all_roots(multiple=True, radicals=True)[source]

Return a list of real and complex roots with multiplicities.

See all_roots() for more explanation.

Examples

@@ -2462,7 +2462,7 @@

Basic polynomial manipulation functions
-all_terms()[source]
+all_terms()[source]

Returns all terms from a univariate polynomial f.

Examples

>>> from sympy import Poly
@@ -2477,7 +2477,7 @@ 

Basic polynomial manipulation functions
-as_dict(native=False, zero=False)[source]
+as_dict(native=False, zero=False)[source]

Switch to a dict representation.

Examples

>>> from sympy import Poly
@@ -2492,7 +2492,7 @@ 

Basic polynomial manipulation functions
-as_expr(*gens)[source]
+as_expr(*gens)[source]

Convert a Poly instance to an Expr instance.

Examples

>>> from sympy import Poly
@@ -2514,13 +2514,13 @@ 

Basic polynomial manipulation functions
-as_list(native=False)[source]
+as_list(native=False)[source]

Switch to a list representation.

-as_poly(*gens, **args)[source]
+as_poly(*gens, **args)[source]

Converts self to a polynomial or returns None.

>>> from sympy import sin
 >>> from sympy.abc import x, y
@@ -2542,7 +2542,7 @@ 

Basic polynomial manipulation functions
-cancel(g, include=False)[source]
+cancel(g, include=False)[source]

Cancel common factors in a rational function f/g.

Examples

>>> from sympy import Poly
@@ -2561,7 +2561,7 @@ 

Basic polynomial manipulation functions
-clear_denoms(convert=False)[source]
+clear_denoms(convert=False)[source]

Clear denominators, but keep the ground domain.

Examples

>>> from sympy import Poly, S, QQ
@@ -2581,7 +2581,7 @@ 

Basic polynomial manipulation functions
-coeff_monomial(monom)[source]
+coeff_monomial(monom)[source]

Returns the coefficient of monom in f if there, else None.

Examples

>>> from sympy import Poly, exp
@@ -2621,7 +2621,7 @@ 

Basic polynomial manipulation functions
-coeffs(order=None)[source]
+coeffs(order=None)[source]

Returns all non-zero coefficients from f in lex order.

Examples

>>> from sympy import Poly
@@ -2640,7 +2640,7 @@ 

Basic polynomial manipulation functions
-cofactors(g)[source]
+cofactors(g)[source]

Returns the GCD of f and g and their cofactors.

Returns polynomials (h, cff, cfg) such that h = gcd(f, g), and cff = quo(f, h) and cfg = quo(g, h) are, so called, cofactors @@ -2660,7 +2660,7 @@

Basic polynomial manipulation functions
-compose(g)[source]
+compose(g)[source]

Computes the functional composition of f and g.

Examples

>>> from sympy import Poly
@@ -2675,7 +2675,7 @@ 

Basic polynomial manipulation functions
-content()[source]
+content()[source]

Returns the GCD of polynomial coefficients.

Examples

>>> from sympy import Poly
@@ -2690,7 +2690,7 @@ 

Basic polynomial manipulation functions
-count_roots(inf=None, sup=None)[source]
+count_roots(inf=None, sup=None)[source]

Return the number of roots of f in [inf, sup] interval.

Examples

>>> from sympy import Poly, I
@@ -2707,7 +2707,7 @@ 

Basic polynomial manipulation functions
-decompose()[source]
+decompose()[source]

Computes a functional decomposition of f.

Examples

>>> from sympy import Poly
@@ -2722,7 +2722,7 @@ 

Basic polynomial manipulation functions
-deflate()[source]
+deflate()[source]

Reduce degree of f by mapping x_i**m to y_i.

Examples

>>> from sympy import Poly
@@ -2737,7 +2737,7 @@ 

Basic polynomial manipulation functions
-degree(gen=0)[source]
+degree(gen=0)[source]

Returns degree of f in x_j.

The degree of 0 is negative infinity.

Examples

@@ -2757,7 +2757,7 @@

Basic polynomial manipulation functions
-degree_list()[source]
+degree_list()[source]

Returns a list of degrees of f.

Examples

>>> from sympy import Poly
@@ -2772,7 +2772,7 @@ 

Basic polynomial manipulation functions
-diff(*specs, **kwargs)[source]
+diff(*specs, **kwargs)[source]

Computes partial derivative of f.

Examples

>>> from sympy import Poly
@@ -2791,7 +2791,7 @@ 

Basic polynomial manipulation functions
-discriminant()[source]
+discriminant()[source]

Computes the discriminant of f.

Examples

>>> from sympy import Poly
@@ -2806,7 +2806,7 @@ 

Basic polynomial manipulation functions
-dispersion(g=None)[source]
+dispersion(g=None)[source]

Compute the dispersion of polynomials.

For two polynomials \(f(x)\) and \(g(x)\) with \(\deg f > 0\) and \(\deg g > 0\) the dispersion \(\operatorname{dis}(f, g)\) is defined as:

@@ -2877,7 +2877,7 @@

Basic polynomial manipulation functions
-dispersionset(g=None)[source]
+dispersionset(g=None)[source]

Compute the dispersion set of two polynomials.

For two polynomials \(f(x)\) and \(g(x)\) with \(\deg f > 0\) and \(\deg g > 0\) the dispersion set \(\operatorname{J}(f, g)\) is defined as:

@@ -2948,7 +2948,7 @@

Basic polynomial manipulation functions
-div(g, auto=True)[source]
+div(g, auto=True)[source]

Polynomial division with remainder of f by g.

Examples

>>> from sympy import Poly
@@ -2991,7 +2991,7 @@ 

Basic polynomial manipulation functions
-eject(*gens)[source]
+eject(*gens)[source]

Eject selected generators into the ground domain.

Examples

>>> from sympy import Poly
@@ -3011,7 +3011,7 @@ 

Basic polynomial manipulation functions
-eval(x, a=None, auto=True)[source]
+eval(x, a=None, auto=True)[source]

Evaluate f at a in the given variable.

Examples

>>> from sympy import Poly
@@ -3047,7 +3047,7 @@ 

Basic polynomial manipulation functions
-exclude()[source]
+exclude()[source]

Remove unnecessary generators from f.

Examples

>>> from sympy import Poly
@@ -3062,7 +3062,7 @@ 

Basic polynomial manipulation functions
-exquo(g, auto=True)[source]
+exquo(g, auto=True)[source]

Computes polynomial exact quotient of f by g.

Examples

>>> from sympy import Poly
@@ -3083,7 +3083,7 @@ 

Basic polynomial manipulation functions
-exquo_ground(coeff)[source]
+exquo_ground(coeff)[source]

Exact quotient of f by a an element of the ground domain.

Examples

>>> from sympy import Poly
@@ -3104,7 +3104,7 @@ 

Basic polynomial manipulation functions
-factor_list()[source]
+factor_list()[source]

Returns a list of irreducible factors of f.

Examples

>>> from sympy import Poly
@@ -3123,7 +3123,7 @@ 

Basic polynomial manipulation functions
-factor_list_include()[source]
+factor_list_include()[source]

Returns a list of irreducible factors of f.

Examples

>>> from sympy import Poly
@@ -3182,25 +3182,25 @@ 

Basic polynomial manipulation functions
-classmethod from_dict(rep, *gens, **args)[source]
+classmethod from_dict(rep, *gens, **args)[source]

Construct a polynomial from a dict.

-classmethod from_expr(rep, *gens, **args)[source]
+classmethod from_expr(rep, *gens, **args)[source]

Construct a polynomial from an expression.

-classmethod from_list(rep, *gens, **args)[source]
+classmethod from_list(rep, *gens, **args)[source]

Construct a polynomial from a list.

-classmethod from_poly(rep, *gens, **args)[source]
+classmethod from_poly(rep, *gens, **args)[source]

Construct a polynomial from a polynomial.

@@ -3214,7 +3214,7 @@

Basic polynomial manipulation functionsrandomize=False,

-)[source] +)[source]

Compute the Galois group of this polynomial.

Examples

>>> from sympy import Poly
@@ -3233,7 +3233,7 @@ 

Basic polynomial manipulation functions
-gcd(g)[source]
+gcd(g)[source]

Returns the polynomial GCD of f and g.

Examples

>>> from sympy import Poly
@@ -3248,7 +3248,7 @@ 

Basic polynomial manipulation functions
-gcdex(g, auto=True)[source]
+gcdex(g, auto=True)[source]

Extended Euclidean algorithm of f and g.

Returns (s, t, h) such that h = gcd(f, g) and s*f + t*g = h.

Examples

@@ -3285,13 +3285,13 @@

Basic polynomial manipulation functions
-get_domain()[source]
+get_domain()[source]

Get the ground domain of f.

-get_modulus()[source]
+get_modulus()[source]

Get the modulus of f.

Examples

>>> from sympy import Poly
@@ -3306,7 +3306,7 @@ 

Basic polynomial manipulation functions
-gff_list()[source]
+gff_list()[source]

Computes greatest factorial factorization of f.

Examples

>>> from sympy import Poly
@@ -3324,7 +3324,7 @@ 

Basic polynomial manipulation functions
-ground_roots()[source]
+ground_roots()[source]

Compute roots of f by factorization in the ground domain.

Examples

>>> from sympy import Poly
@@ -3339,7 +3339,7 @@ 

Basic polynomial manipulation functions
-half_gcdex(g, auto=True)[source]
+half_gcdex(g, auto=True)[source]

Half extended Euclidean algorithm of f and g.

Returns (s, h) such that h = gcd(f, g) and s*f = h (mod g).

Examples

@@ -3359,7 +3359,7 @@

Basic polynomial manipulation functions
-has_only_gens(*gens)[source]
+has_only_gens(*gens)[source]

Return True if Poly(f, *gens) retains ground domain.

Examples

>>> from sympy import Poly
@@ -3376,7 +3376,7 @@ 

Basic polynomial manipulation functions
-homogeneous_order()[source]
+homogeneous_order()[source]

Returns the homogeneous order of f.

A homogeneous polynomial is a polynomial whose all monomials with non-zero coefficients have the same total degree. This degree is @@ -3396,7 +3396,7 @@

Basic polynomial manipulation functions
-homogenize(s)[source]
+homogenize(s)[source]

Returns the homogeneous polynomial of f.

A homogeneous polynomial is a polynomial whose all monomials with non-zero coefficients have the same total degree. If you only @@ -3418,7 +3418,7 @@

Basic polynomial manipulation functions
-inject(front=False)[source]
+inject(front=False)[source]

Inject ground domain generators into f.

Examples

>>> from sympy import Poly
@@ -3438,7 +3438,7 @@ 

Basic polynomial manipulation functions
-integrate(*specs, **args)[source]
+integrate(*specs, **args)[source]

Computes indefinite integral of f.

Examples

>>> from sympy import Poly
@@ -3468,7 +3468,7 @@ 

Basic polynomial manipulation functionssqf=False,

-)[source] +)[source]

Compute isolating intervals for roots of f.

For real roots the Vincent-Akritas-Strzebonski (VAS) continued fractions method is used.

Examples

@@ -3500,7 +3500,7 @@

Basic polynomial manipulation functions
-invert(g, auto=True)[source]
+invert(g, auto=True)[source]

Invert f modulo g when possible.

Examples

>>> from sympy import Poly
@@ -3781,7 +3781,7 @@ 

Basic polynomial manipulation functions
-l1_norm()[source]
+l1_norm()[source]

Returns l1 norm of f.

Examples

>>> from sympy import Poly
@@ -3796,7 +3796,7 @@ 

Basic polynomial manipulation functions
-lcm(g)[source]
+lcm(g)[source]

Returns polynomial LCM of f and g.

Examples

>>> from sympy import Poly
@@ -3811,7 +3811,7 @@ 

Basic polynomial manipulation functions
-length()[source]
+length()[source]

Returns the number of non-zero terms in f.

Examples

>>> from sympy import Poly
@@ -3826,7 +3826,7 @@ 

Basic polynomial manipulation functions
-lift()[source]
+lift()[source]

Convert algebraic coefficients to rationals.

Examples

>>> from sympy import Poly, I
@@ -3841,7 +3841,7 @@ 

Basic polynomial manipulation functions
-ltrim(gen)[source]
+ltrim(gen)[source]

Remove dummy generators from f that are to the left of specified gen in the generators as ordered. When gen is an integer, it refers to the generator located at that @@ -3861,7 +3861,7 @@

Basic polynomial manipulation functions
-make_monic_over_integers_by_scaling_roots()[source]
+make_monic_over_integers_by_scaling_roots()[source]

Turn any univariate polynomial over QQ or ZZ into a monic polynomial over ZZ, by scaling the roots as necessary.

@@ -3889,13 +3889,13 @@

Basic polynomial manipulation functions
-match(*args, **kwargs)[source]
+match(*args, **kwargs)[source]

Match expression from Poly. See Basic.match()

-max_norm()[source]
+max_norm()[source]

Returns maximum norm of f.

Examples

>>> from sympy import Poly
@@ -3910,7 +3910,7 @@ 

Basic polynomial manipulation functions
-monic(auto=True)[source]
+monic(auto=True)[source]

Divides all coefficients by LC(f).

Examples

>>> from sympy import Poly, ZZ
@@ -3929,7 +3929,7 @@ 

Basic polynomial manipulation functions
-monoms(order=None)[source]
+monoms(order=None)[source]

Returns all non-zero monomials from f in lex order.

Examples

>>> from sympy import Poly
@@ -3948,7 +3948,7 @@ 

Basic polynomial manipulation functions
-mul(g)[source]
+mul(g)[source]

Multiply two polynomials f and g.

Examples

>>> from sympy import Poly
@@ -3967,7 +3967,7 @@ 

Basic polynomial manipulation functions
-mul_ground(coeff)[source]
+mul_ground(coeff)[source]

Multiply f by a an element of the ground domain.

Examples

>>> from sympy import Poly
@@ -3982,7 +3982,7 @@ 

Basic polynomial manipulation functions
-neg()[source]
+neg()[source]

Negate all coefficients in f.

Examples

>>> from sympy import Poly
@@ -4001,13 +4001,13 @@ 

Basic polynomial manipulation functions
-classmethod new(rep, *gens)[source]
+classmethod new(rep, *gens)[source]

Construct Poly instance from raw representation.

-norm()[source]
+norm()[source]

Computes the product, Norm(f), of the conjugates of a polynomial f defined over a number field K.

Examples

@@ -4036,7 +4036,7 @@

Basic polynomial manipulation functions
-nroots(n=15, maxsteps=50, cleanup=True)[source]
+nroots(n=15, maxsteps=50, cleanup=True)[source]

Compute numerical approximations of roots of f.

Parameters:
@@ -4061,7 +4061,7 @@

Basic polynomial manipulation functions
-nth(*N)[source]
+nth(*N)[source]

Returns the n-th coefficient of f where N are the exponents of the generators in the term of interest.

Examples

@@ -4087,7 +4087,7 @@

Basic polynomial manipulation functions
-nth_power_roots_poly(n)[source]
+nth_power_roots_poly(n)[source]

Construct a polynomial with n-th powers of roots of f.

Examples

>>> from sympy import Poly
@@ -4117,7 +4117,7 @@ 

Basic polynomial manipulation functions
-pdiv(g)[source]
+pdiv(g)[source]

Polynomial pseudo-division of f by g.

Examples

>>> from sympy import Poly
@@ -4132,7 +4132,7 @@ 

Basic polynomial manipulation functions
-per(rep, gens=None, remove=None)[source]
+per(rep, gens=None, remove=None)[source]

Create a Poly out of the given representation.

Examples

>>> from sympy import Poly, ZZ
@@ -4153,7 +4153,7 @@ 

Basic polynomial manipulation functions
-pexquo(g)[source]
+pexquo(g)[source]

Polynomial exact pseudo-quotient of f by g.

Examples

>>> from sympy import Poly
@@ -4174,7 +4174,7 @@ 

Basic polynomial manipulation functions
-pow(n)[source]
+pow(n)[source]

Raise f to a non-negative power n.

Examples

>>> from sympy import Poly
@@ -4193,7 +4193,7 @@ 

Basic polynomial manipulation functions
-pquo(g)[source]
+pquo(g)[source]

Polynomial pseudo-quotient of f by g.

See the Caveat note in the function prem(f, g).

Examples

@@ -4213,7 +4213,7 @@

Basic polynomial manipulation functions
-prem(g)[source]
+prem(g)[source]

Polynomial pseudo-remainder of f by g.

Caveat: The function prem(f, g, x) can be safely used to compute

in Z[x] _only_ subresultant polynomial remainder sequences (prs’s).

@@ -4242,7 +4242,7 @@

Basic polynomial manipulation functions
-primitive()[source]
+primitive()[source]

Returns the content and a primitive form of f.

Examples

>>> from sympy import Poly
@@ -4257,7 +4257,7 @@ 

Basic polynomial manipulation functions
-quo(g, auto=True)[source]
+quo(g, auto=True)[source]

Computes polynomial quotient of f by g.

Examples

>>> from sympy import Poly
@@ -4276,7 +4276,7 @@ 

Basic polynomial manipulation functions
-quo_ground(coeff)[source]
+quo_ground(coeff)[source]

Quotient of f by a an element of the ground domain.

Examples

>>> from sympy import Poly
@@ -4295,7 +4295,7 @@ 

Basic polynomial manipulation functions
-rat_clear_denoms(g)[source]
+rat_clear_denoms(g)[source]

Clear denominators in a rational function f/g.

Examples

>>> from sympy import Poly
@@ -4319,7 +4319,7 @@ 

Basic polynomial manipulation functions
-real_roots(multiple=True, radicals=True)[source]
+real_roots(multiple=True, radicals=True)[source]

Return a list of real roots with multiplicities.

See real_roots() for more explanation.

Examples

@@ -4348,7 +4348,7 @@

Basic polynomial manipulation functionscheck_sqf=False,

-)[source] +)[source]

Refine an isolating interval of a root to the given precision.

Examples

>>> from sympy import Poly
@@ -4363,7 +4363,7 @@ 

Basic polynomial manipulation functions
-rem(g, auto=True)[source]
+rem(g, auto=True)[source]

Computes the polynomial remainder of f by g.

Examples

>>> from sympy import Poly
@@ -4382,7 +4382,7 @@ 

Basic polynomial manipulation functions
-reorder(*gens, **args)[source]
+reorder(*gens, **args)[source]

Efficiently apply new order of generators.

Examples

>>> from sympy import Poly
@@ -4397,7 +4397,7 @@ 

Basic polynomial manipulation functions
-replace(x, y=None, **_ignore)[source]
+replace(x, y=None, **_ignore)[source]

Replace x with y in generators list.

Examples

>>> from sympy import Poly
@@ -4412,7 +4412,7 @@ 

Basic polynomial manipulation functions
-resultant(g, includePRS=False)[source]
+resultant(g, includePRS=False)[source]

Computes the resultant of f and g via PRS.

If includePRS=True, it includes the subresultant PRS in the result. Because the PRS is used to calculate the resultant, this is more @@ -4436,7 +4436,7 @@

Basic polynomial manipulation functions
-retract(field=None)[source]
+retract(field=None)[source]

Recalculate the ground domain of a polynomial.

Examples

>>> from sympy import Poly
@@ -4458,7 +4458,7 @@ 

Basic polynomial manipulation functions
-revert(n)[source]
+revert(n)[source]

Compute f**(-1) mod x**n.

Examples

>>> from sympy import Poly
@@ -4489,7 +4489,7 @@ 

Basic polynomial manipulation functions
-root(index, radicals=True)[source]
+root(index, radicals=True)[source]

Get an indexed root of a polynomial.

Examples

>>> from sympy import Poly
@@ -4519,7 +4519,7 @@ 

Basic polynomial manipulation functions
-same_root(a, b)[source]
+same_root(a, b)[source]

Decide whether two roots of this polynomial are equal.

Raises:
@@ -4555,13 +4555,13 @@

Basic polynomial manipulation functions
-set_domain(domain)[source]
+set_domain(domain)[source]

Set the ground domain of f.

-set_modulus(modulus)[source]
+set_modulus(modulus)[source]

Set the modulus of f.

Examples

>>> from sympy import Poly
@@ -4576,7 +4576,7 @@ 

Basic polynomial manipulation functions
-shift(a)[source]
+shift(a)[source]

Efficiently compute Taylor shift f(x + a).

Examples

>>> from sympy import Poly
@@ -4598,7 +4598,7 @@ 

Basic polynomial manipulation functions
-shift_list(a)[source]
+shift_list(a)[source]

Efficiently compute Taylor shift f(X + A).

Examples

>>> from sympy import Poly
@@ -4620,13 +4620,13 @@ 

Basic polynomial manipulation functions
-slice(x, m, n=None)[source]
+slice(x, m, n=None)[source]

Take a continuous subsequence of terms of f.

-sqf_list(all=False)[source]
+sqf_list(all=False)[source]

Returns a list of square-free factors of f.

Examples

>>> from sympy import Poly
@@ -4651,7 +4651,7 @@ 

Basic polynomial manipulation functions
-sqf_list_include(all=False)[source]
+sqf_list_include(all=False)[source]

Returns a list of square-free factors of f.

Examples

>>> from sympy import Poly, expand
@@ -4680,7 +4680,7 @@ 

Basic polynomial manipulation functions
-sqf_norm()[source]
+sqf_norm()[source]

Computes square-free norm of f.

Returns s, f, r, such that g(x) = f(x-sa) and r(x) = Norm(g(x)) is a square-free polynomial over K, @@ -4705,7 +4705,7 @@

Basic polynomial manipulation functions
-sqf_part()[source]
+sqf_part()[source]

Computes square-free part of f.

Examples

>>> from sympy import Poly
@@ -4720,7 +4720,7 @@ 

Basic polynomial manipulation functions
-sqr()[source]
+sqr()[source]

Square a polynomial f.

Examples

>>> from sympy import Poly
@@ -4739,7 +4739,7 @@ 

Basic polynomial manipulation functions
-sturm(auto=True)[source]
+sturm(auto=True)[source]

Computes the Sturm sequence of f.

Examples

>>> from sympy import Poly
@@ -4757,7 +4757,7 @@ 

Basic polynomial manipulation functions
-sub(g)[source]
+sub(g)[source]

Subtract two polynomials f and g.

Examples

>>> from sympy import Poly
@@ -4776,7 +4776,7 @@ 

Basic polynomial manipulation functions
-sub_ground(coeff)[source]
+sub_ground(coeff)[source]

Subtract an element of the ground domain from f.

Examples

>>> from sympy import Poly
@@ -4791,7 +4791,7 @@ 

Basic polynomial manipulation functions
-subresultants(g)[source]
+subresultants(g)[source]

Computes the subresultant PRS of f and g.

Examples

>>> from sympy import Poly
@@ -4808,7 +4808,7 @@ 

Basic polynomial manipulation functions
-terms(order=None)[source]
+terms(order=None)[source]

Returns all non-zero terms from f in lex order.

Examples

>>> from sympy import Poly
@@ -4827,7 +4827,7 @@ 

Basic polynomial manipulation functions
-terms_gcd()[source]
+terms_gcd()[source]

Remove GCD of terms from the polynomial f.

Examples

>>> from sympy import Poly
@@ -4842,7 +4842,7 @@ 

Basic polynomial manipulation functions
-termwise(func, *gens, **args)[source]
+termwise(func, *gens, **args)[source]

Apply a function to all terms of f.

Examples

>>> from sympy import Poly
@@ -4862,7 +4862,7 @@ 

Basic polynomial manipulation functions
-to_exact()[source]
+to_exact()[source]

Make the ground domain exact.

Examples

>>> from sympy import Poly, RR
@@ -4877,7 +4877,7 @@ 

Basic polynomial manipulation functions
-to_field()[source]
+to_field()[source]

Make the ground domain a field.

Examples

>>> from sympy import Poly, ZZ
@@ -4892,7 +4892,7 @@ 

Basic polynomial manipulation functions
-to_ring()[source]
+to_ring()[source]

Make the ground domain a ring.

Examples

>>> from sympy import Poly, QQ
@@ -4907,7 +4907,7 @@ 

Basic polynomial manipulation functions
-total_degree()[source]
+total_degree()[source]

Returns the total degree of f.

Examples

>>> from sympy import Poly
@@ -4924,7 +4924,7 @@ 

Basic polynomial manipulation functions
-transform(p, q)[source]
+transform(p, q)[source]

Efficiently evaluate the functional transformation q**n * f(p/q).

Examples

>>> from sympy import Poly
@@ -4939,7 +4939,7 @@ 

Basic polynomial manipulation functions
-trunc(p)[source]
+trunc(p)[source]

Reduce f modulo a constant p.

Examples

>>> from sympy import Poly
@@ -4954,7 +4954,7 @@ 

Basic polynomial manipulation functions
-unify(g)[source]
+unify(g)[source]

Make f and g belong to the same domain.

Examples

>>> from sympy import Poly
@@ -4989,7 +4989,7 @@ 

Basic polynomial manipulation functions
-which_all_roots(candidates)[source]
+which_all_roots(candidates)[source]

Find roots of a square-free polynomial f from candidates.

Explanation

If f is a square-free polynomial and candidates is a superset @@ -5042,7 +5042,7 @@

Basic polynomial manipulation functions
-which_real_roots(candidates)[source]
+which_real_roots(candidates)[source]

Find roots of a square-free polynomial f from candidates.

Explanation

If f is a square-free polynomial and candidates is a superset @@ -5099,7 +5099,7 @@

Basic polynomial manipulation functions
-class sympy.polys.polytools.PurePoly(rep, *gens, **args)[source]
+class sympy.polys.polytools.PurePoly(rep, *gens, **args)[source]

Class for representing pure polynomials.

@@ -5124,11 +5124,11 @@

Basic polynomial manipulation functions
-class sympy.polys.polytools.GroebnerBasis(F, *gens, **args)[source]
+class sympy.polys.polytools.GroebnerBasis(F, *gens, **args)[source]

Represents a reduced Groebner basis.

-contains(poly)[source]
+contains(poly)[source]

Check if poly belongs the ideal generated by self.

Examples

>>> from sympy import groebner
@@ -5149,7 +5149,7 @@ 

Basic polynomial manipulation functions
-fglm(order)[source]
+fglm(order)[source]

Convert a Groebner basis from one ordering to another.

The FGLM algorithm converts reduced Groebner bases of zero-dimensional ideals from one ordering to another. This method is often used when it @@ -5194,7 +5194,7 @@

Basic polynomial manipulation functions
-reduce(expr, auto=True)[source]
+reduce(expr, auto=True)[source]

Reduces a polynomial modulo a Groebner basis.

Given a polynomial f and a set of polynomials G = (g_1, ..., g_n), computes a set of quotients q = (q_1, ..., q_n) and the remainder r @@ -5229,7 +5229,7 @@

Basic polynomial manipulation functions

-sympy.polys.polyfuncs.symmetrize(F, *gens, **args)[source]
+sympy.polys.polyfuncs.symmetrize(F, *gens, **args)[source]

Rewrite a polynomial in terms of elementary symmetric polynomials.

A symmetric polynomial is a multivariate polynomial that remains invariant under any variable permutation, i.e., if \(f = f(x_1, x_2, \dots, x_n)\), @@ -5263,7 +5263,7 @@

Extra polynomial manipulation functions
-sympy.polys.polyfuncs.horner(f, *gens, **args)[source]
+sympy.polys.polyfuncs.horner(f, *gens, **args)[source]

Rewrite a polynomial in Horner form.

Among other applications, evaluation of a polynomial at a point is optimal when it is applied using the Horner scheme ([1]).

@@ -5297,7 +5297,7 @@

Extra polynomial manipulation functions
-sympy.polys.polyfuncs.interpolate(data, x)[source]
+sympy.polys.polyfuncs.interpolate(data, x)[source]

Construct an interpolating polynomial for the data points evaluated at point x (which can be symbolic or numeric).

Examples

@@ -5339,7 +5339,7 @@

Extra polynomial manipulation functions
-sympy.polys.polyfuncs.viete(f, roots=None, *gens, **args)[source]
+sympy.polys.polyfuncs.viete(f, roots=None, *gens, **args)[source]

Generate Viete’s formulas for f.

Examples

>>> from sympy.polys.polyfuncs import viete
@@ -5360,7 +5360,7 @@ 

Extra polynomial manipulation functions

-sympy.polys.constructor.construct_domain(obj, **args)[source]
+sympy.polys.constructor.construct_domain(obj, **args)[source]

Construct a minimal domain for a list of expressions.

Parameters:
@@ -5444,23 +5444,23 @@

Domain constructors

-class sympy.polys.monomials.Monomial(monom, gens=None)[source]
+class sympy.polys.monomials.Monomial(monom, gens=None)[source]

Class representing a monomial, i.e. a product of powers.

-as_expr(*gens)[source]
+as_expr(*gens)[source]

Convert a monomial instance to a SymPy expression.

-gcd(other)[source]
+gcd(other)[source]

Greatest common divisor of monomials.

-lcm(other)[source]
+lcm(other)[source]

Least common multiple of monomials.

@@ -5476,7 +5476,7 @@

Monomials encoded as tuplesmin_degrees=None,

-)[source] +)[source]

max_degrees and min_degrees are either both integers or both lists. Unless otherwise specified, min_degrees is either 0 or [0, ..., 0].

@@ -5547,7 +5547,7 @@

Monomials encoded as tuples
-sympy.polys.monomials.monomial_count(V, N)[source]
+sympy.polys.monomials.monomial_count(V, N)[source]

Computes the number of monomials.

The number of monomials is given by the following formula:

@@ -5581,25 +5581,25 @@

Monomials encoded as tuples

-class sympy.polys.orderings.MonomialOrder[source]
+class sympy.polys.orderings.MonomialOrder[source]

Base class for monomial orderings.

-class sympy.polys.orderings.LexOrder[source]
+class sympy.polys.orderings.LexOrder[source]

Lexicographic order of monomials.

-class sympy.polys.orderings.GradedLexOrder[source]
+class sympy.polys.orderings.GradedLexOrder[source]

Graded lexicographic order of monomials.

-class sympy.polys.orderings.ReversedGradedLexOrder[source]
+class sympy.polys.orderings.ReversedGradedLexOrder[source]

Reversed graded lexicographic order of monomials.

@@ -5618,7 +5618,7 @@

Formal manipulation of roots of polynomialsexpand=True,

-)[source] +)[source]

An indexed root of a univariate polynomial.

Returns either a ComplexRootOf object or an explicit expression involving radicals.

@@ -5657,7 +5657,7 @@

Formal manipulation of roots of polynomialsexpand=True,

-)[source] +)[source]

Represents a root of a univariate polynomial.

Base class for roots of different kinds of polynomials. Only complex roots are currently supported.

@@ -5675,7 +5675,7 @@

Formal manipulation of roots of polynomialsexpand=True,

-)[source] +)[source]

Represents an indexed complex root of a polynomial.

Roots of a univariate polynomial separated into disjoint real or complex intervals and indexed in a fixed order:

@@ -5798,56 +5798,56 @@

Formal manipulation of roots of polynomials
-classmethod _all_roots(poly, use_cache=True)[source]
+classmethod _all_roots(poly, use_cache=True)[source]

Get real and complex roots of a composite polynomial.

-classmethod _complexes_index(complexes, index)[source]
+classmethod _complexes_index(complexes, index)[source]

Map initial complex root index to an index in a factor where the root belongs.

-classmethod _complexes_sorted(complexes)[source]
+classmethod _complexes_sorted(complexes)[source]

Make complex isolating intervals disjoint and sort roots.

-classmethod _count_roots(roots)[source]
+classmethod _count_roots(roots)[source]

Count the number of real or complex roots with multiplicities.

-_ensure_complexes_init()[source]
+_ensure_complexes_init()[source]

Ensure that our poly has entries in the complexes cache.

-_ensure_reals_init()[source]
+_ensure_reals_init()[source]

Ensure that our poly has entries in the reals cache.

-_eval_evalf(prec, **kwargs)[source]
+_eval_evalf(prec, **kwargs)[source]

Evaluate this complex root to the given precision.

-_eval_is_imaginary()[source]
+_eval_is_imaginary()[source]

Return True if the root is imaginary.

-_eval_is_real()[source]
+_eval_is_real()[source]

Return True if the root is real.

@@ -5860,7 +5860,7 @@

Formal manipulation of roots of polynomialsuse_cache=True,

-)[source] +)[source]

Compute complex root isolating intervals for a list of factors.

@@ -5873,19 +5873,19 @@

Formal manipulation of roots of polynomialsuse_cache=True,

-)[source] +)[source]

Get complex root isolating intervals for a square-free factor.

-_get_interval()[source]
+_get_interval()[source]

Internal function for retrieving isolation interval from cache.

-classmethod _get_reals(factors, use_cache=True)[source]
+classmethod _get_reals(factors, use_cache=True)[source]

Compute real root isolating intervals for a list of factors.

@@ -5898,13 +5898,13 @@

Formal manipulation of roots of polynomialsuse_cache=True,

-)[source] +)[source]

Get real root isolating intervals for a square-free factor.

-classmethod _get_roots(method, poly, radicals)[source]
+classmethod _get_roots(method, poly, radicals)[source]

Return postprocessed roots of specified kind.

@@ -5918,7 +5918,7 @@

Formal manipulation of roots of polynomialsradicals,

-)[source] +)[source]

Return postprocessed roots of specified kind for polynomials with algebraic coefficients. It assumes the domain is already an algebraic field. First it @@ -5937,7 +5937,7 @@

Formal manipulation of roots of polynomialsradicals,

-)[source] +)[source]

Return postprocessed roots of specified kind for polynomials with rational coefficients.

@@ -5952,50 +5952,50 @@

Formal manipulation of roots of polynomialslazy=False,

-)[source] +)[source]

Get a root of a composite polynomial by index.

-classmethod _new(poly, index)[source]
+classmethod _new(poly, index)[source]

Construct new CRootOf object from raw data.

-classmethod _postprocess_root(root, radicals)[source]
+classmethod _postprocess_root(root, radicals)[source]

Return the root if it is trivial or a CRootOf object.

-classmethod _preprocess_roots(poly)[source]
+classmethod _preprocess_roots(poly)[source]

Take heroic measures to make poly compatible with CRootOf.

-classmethod _real_roots(poly)[source]
+classmethod _real_roots(poly)[source]

Get real roots of a composite polynomial.

-classmethod _reals_index(reals, index)[source]
+classmethod _reals_index(reals, index)[source]

Map initial real root index to an index in a factor where the root belongs.

-classmethod _reals_sorted(reals)[source]
+classmethod _reals_sorted(reals)[source]

Make real isolating intervals disjoint and sort roots.

-classmethod _refine_complexes(complexes)[source]
+classmethod _refine_complexes(complexes)[source]

return complexes such that no bounding rectangles of non-conjugate roots would intersect. In addition, assure that neither ay nor by is 0 to guarantee that non-real roots are distinct from real roots in @@ -6004,31 +6004,31 @@

Formal manipulation of roots of polynomials
-_reset()[source]
+_reset()[source]

Reset all intervals

-classmethod _roots_trivial(poly, radicals)[source]
+classmethod _roots_trivial(poly, radicals)[source]

Compute roots in linear, quadratic and binomial cases.

-_set_interval(interval)[source]
+_set_interval(interval)[source]

Internal function for updating isolation interval in cache.

-classmethod all_roots(poly, radicals=True)[source]
+classmethod all_roots(poly, radicals=True)[source]

Get real and complex roots of a polynomial.

-classmethod clear_cache()[source]
+classmethod clear_cache()[source]

Reset cache for reals and complexes.

The intervals used to approximate a root instance are updated as needed. When a request is made to see the intervals, the @@ -6042,7 +6042,7 @@

Formal manipulation of roots of polynomials
-eval_approx(n, return_mpmath=False)[source]
+eval_approx(n, return_mpmath=False)[source]

Evaluate this complex root to the given precision.

This uses secant method and root bounds are used to both generate an initial guess and to check that the root @@ -6060,7 +6060,7 @@

Formal manipulation of roots of polynomialsn=15,

-)[source] +)[source]

Return a Rational approximation of self that has real and imaginary component approximations that are within dx and dy of the true values, respectively. Alternatively, @@ -6093,7 +6093,7 @@

Formal manipulation of roots of polynomials
-classmethod real_roots(poly, radicals=True)[source]
+classmethod real_roots(poly, radicals=True)[source]

Get real roots of a polynomial.

@@ -6111,11 +6111,11 @@

Formal manipulation of roots of polynomialsquadratic=False,

-)[source] +)[source]

Represents a sum of all roots of a univariate polynomial.

-classmethod new(poly, func, auto=True)[source]
+classmethod new(poly, func, auto=True)[source]

Construct new RootSum instance.

@@ -6143,7 +6143,7 @@

Symbolic root-finding algorithms**flags,

-)[source] +)[source]

Computes symbolic roots of a univariate polynomial.

Given a univariate polynomial f with symbolic coefficients (or a list of the polynomial’s coefficients), returns a dictionary @@ -6245,7 +6245,7 @@

Symbolic root-finding algorithms

-sympy.polys.specialpolys.swinnerton_dyer_poly(n, x=None, polys=False)[source]
+sympy.polys.specialpolys.swinnerton_dyer_poly(n, x=None, polys=False)[source]

Generates n-th Swinnerton-Dyer polynomial in \(x\).

Parameters:
@@ -6265,7 +6265,7 @@

Special polynomials
-sympy.polys.specialpolys.interpolating_poly(n, x, X='x', Y='y')[source]
+sympy.polys.specialpolys.interpolating_poly(n, x, X='x', Y='y')[source]

Construct Lagrange interpolating polynomial for n data points. If a sequence of values are given for X and Y then the first n values will be used.

@@ -6273,7 +6273,7 @@

Special polynomials
-sympy.polys.specialpolys.cyclotomic_poly(n, x=None, polys=False)[source]
+sympy.polys.specialpolys.cyclotomic_poly(n, x=None, polys=False)[source]

Generates cyclotomic polynomial of order \(n\) in \(x\).

Parameters:
@@ -6293,7 +6293,7 @@

Special polynomials
-sympy.polys.specialpolys.symmetric_poly(n, *gens, polys=False)[source]
+sympy.polys.specialpolys.symmetric_poly(n, *gens, polys=False)[source]

Generates symmetric polynomial of order \(n\).

Parameters:
@@ -6319,7 +6319,7 @@

Special polynomialspolys=False,

-)[source] +)[source]

Generates a polynomial of degree n with coefficients in [inf, sup].

@@ -6359,7 +6359,7 @@

Special polynomials

-sympy.polys.orthopolys.chebyshevt_poly(n, x=None, polys=False)[source]
+sympy.polys.orthopolys.chebyshevt_poly(n, x=None, polys=False)[source]

Generates the Chebyshev polynomial of the first kind \(T_n(x)\).

Parameters:
@@ -6378,7 +6378,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.chebyshevu_poly(n, x=None, polys=False)[source]
+sympy.polys.orthopolys.chebyshevu_poly(n, x=None, polys=False)[source]

Generates the Chebyshev polynomial of the second kind \(U_n(x)\).

Parameters:
@@ -6397,7 +6397,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.gegenbauer_poly(n, a, x=None, polys=False)[source]
+sympy.polys.orthopolys.gegenbauer_poly(n, a, x=None, polys=False)[source]

Generates the Gegenbauer polynomial \(C_n^{(a)}(x)\).

Parameters:
@@ -6420,7 +6420,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.hermite_poly(n, x=None, polys=False)[source]
+sympy.polys.orthopolys.hermite_poly(n, x=None, polys=False)[source]

Generates the Hermite polynomial \(H_n(x)\).

Parameters:
@@ -6439,7 +6439,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.hermite_prob_poly(n, x=None, polys=False)[source]
+sympy.polys.orthopolys.hermite_prob_poly(n, x=None, polys=False)[source]

Generates the probabilist’s Hermite polynomial \(He_n(x)\).

Parameters:
@@ -6458,7 +6458,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.jacobi_poly(n, a, b, x=None, polys=False)[source]
+sympy.polys.orthopolys.jacobi_poly(n, a, b, x=None, polys=False)[source]

Generates the Jacobi polynomial \(P_n^{(a,b)}(x)\).

Parameters:
@@ -6485,7 +6485,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.legendre_poly(n, x=None, polys=False)[source]
+sympy.polys.orthopolys.legendre_poly(n, x=None, polys=False)[source]

Generates the Legendre polynomial \(P_n(x)\).

Parameters:
@@ -6504,7 +6504,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.laguerre_poly(n, x=None, alpha=0, polys=False)[source]
+sympy.polys.orthopolys.laguerre_poly(n, x=None, alpha=0, polys=False)[source]

Generates the Laguerre polynomial \(L_n^{(\alpha)}(x)\).

Parameters:
@@ -6527,7 +6527,7 @@

Orthogonal polynomials
-sympy.polys.orthopolys.spherical_bessel_fn(n, x=None, polys=False)[source]
+sympy.polys.orthopolys.spherical_bessel_fn(n, x=None, polys=False)[source]

Coefficients for the spherical Bessel functions.

These are only needed in the jn() function.

The coefficients are calculated from:

@@ -6568,7 +6568,7 @@

Orthogonal polynomialsAppell sequences

-sympy.polys.appellseqs.bernoulli_poly(n, x=None, polys=False)[source]
+sympy.polys.appellseqs.bernoulli_poly(n, x=None, polys=False)[source]

Generates the Bernoulli polynomial \(\operatorname{B}_n(x)\).

\(\operatorname{B}_n(x)\) is the unique polynomial satisfying

@@ -6636,7 +6636,7 @@

Appell sequences
-sympy.polys.appellseqs.bernoulli_c_poly(n, x=None, polys=False)[source]
+sympy.polys.appellseqs.bernoulli_c_poly(n, x=None, polys=False)[source]

Generates the central Bernoulli polynomial \(\operatorname{B}_n^c(x)\).

These are scaled and shifted versions of the plain Bernoulli polynomials, done in such a way that \(\operatorname{B}_n^c(x)\) is an even or odd function @@ -6663,7 +6663,7 @@

Appell sequences
-sympy.polys.appellseqs.genocchi_poly(n, x=None, polys=False)[source]
+sympy.polys.appellseqs.genocchi_poly(n, x=None, polys=False)[source]

Generates the Genocchi polynomial \(\operatorname{G}_n(x)\).

\(\operatorname{G}_n(x)\) is twice the difference between the plain and central Bernoulli polynomials, so has degree \(n-1\):

@@ -6695,7 +6695,7 @@

Appell sequences
-sympy.polys.appellseqs.euler_poly(n, x=None, polys=False)[source]
+sympy.polys.appellseqs.euler_poly(n, x=None, polys=False)[source]

Generates the Euler polynomial \(\operatorname{E}_n(x)\).

These are scaled and reindexed versions of the Genocchi polynomials:

@@ -6723,7 +6723,7 @@

Appell sequences
-sympy.polys.appellseqs.andre_poly(n, x=None, polys=False)[source]
+sympy.polys.appellseqs.andre_poly(n, x=None, polys=False)[source]

Generates the Andre polynomial \(\mathcal{A}_n(x)\).

This is the Appell sequence where the constant coefficients form the sequence of Euler numbers euler(n). As such they have integer coefficients @@ -6791,7 +6791,7 @@

Appell sequences

-sympy.polys.rationaltools.together(expr, deep=False, fraction=True)[source]
+sympy.polys.rationaltools.together(expr, deep=False, fraction=True)[source]

Denest and combine rational expressions using symbolic methods.

This function takes an expression or a container of expressions and puts it (them) together by denesting and combining rational @@ -6849,7 +6849,7 @@

Manipulation of rational functions

-sympy.polys.partfrac.apart(f, x=None, full=False, **options)[source]
+sympy.polys.partfrac.apart(f, x=None, full=False, **options)[source]

Compute partial fraction decomposition of a rational function.

Given a rational function f, computes the partial fraction decomposition of f. Two algorithms are available: One is based on the @@ -6899,7 +6899,7 @@

Partial fraction decomposition
-sympy.polys.partfrac.apart_list(f, x=None, dummies=None, **options)[source]
+sympy.polys.partfrac.apart_list(f, x=None, dummies=None, **options)[source]

Compute partial fraction decomposition of a rational function and return the result in structured form.

Given a rational function f compute the partial fraction decomposition @@ -7004,7 +7004,7 @@

Partial fraction decomposition
-sympy.polys.partfrac.assemble_partfrac_list(partial_list)[source]
+sympy.polys.partfrac.assemble_partfrac_list(partial_list)[source]

Reassemble a full partial fraction decomposition from a structured result obtained by the function apart_list.

Examples

@@ -7067,7 +7067,7 @@

Partial fraction decomposition

-sympy.polys.dispersion.dispersionset(p, q=None, *gens, **args)[source]
+sympy.polys.dispersion.dispersionset(p, q=None, *gens, **args)[source]

Compute the dispersion set of two polynomials.

For two polynomials \(f(x)\) and \(g(x)\) with \(\deg f > 0\) and \(\deg g > 0\) the dispersion set \(\operatorname{J}(f, g)\) is defined as:

@@ -7150,7 +7150,7 @@

Dispersion of Polynomials
-sympy.polys.dispersion.dispersion(p, q=None, *gens, **args)[source]
+sympy.polys.dispersion.dispersion(p, q=None, *gens, **args)[source]

Compute the dispersion of polynomials.

For two polynomials \(f(x)\) and \(g(x)\) with \(\deg f > 0\) and \(\deg g > 0\) the dispersion \(\operatorname{dis}(f, g)\) is defined as:

diff --git a/dev/modules/polys/ringseries.html b/dev/modules/polys/ringseries.html index 870707b39cb..de514747f91 100644 --- a/dev/modules/polys/ringseries.html +++ b/dev/modules/polys/ringseries.html @@ -966,7 +966,7 @@

Reference
-sympy.polys.ring_series.rs_log(p, x, prec)[source]
+sympy.polys.ring_series.rs_log(p, x, prec)[source]

The Logarithm of p modulo O(x**prec).

Notes

Truncation of integral dx p**-1*d p/dx is used.

@@ -985,7 +985,7 @@

Reference
-sympy.polys.ring_series.rs_LambertW(p, x, prec)[source]
+sympy.polys.ring_series.rs_LambertW(p, x, prec)[source]

Calculate the series expansion of the principal branch of the Lambert W function.

Examples

@@ -1005,7 +1005,7 @@

Reference
-sympy.polys.ring_series.rs_exp(p, x, prec)[source]
+sympy.polys.ring_series.rs_exp(p, x, prec)[source]

Exponentiation of a series modulo O(x**prec)

Examples

>>> from sympy.polys.domains import QQ
@@ -1020,7 +1020,7 @@ 

Reference
-sympy.polys.ring_series.rs_atan(p, x, prec)[source]
+sympy.polys.ring_series.rs_atan(p, x, prec)[source]

The arctangent of a series

Return the series expansion of the atan of p, about 0.

Examples

@@ -1040,7 +1040,7 @@

Reference
-sympy.polys.ring_series.rs_asin(p, x, prec)[source]
+sympy.polys.ring_series.rs_asin(p, x, prec)[source]

Arcsine of a series

Return the series expansion of the asin of p, about 0.

Examples

@@ -1060,7 +1060,7 @@

Reference
-sympy.polys.ring_series.rs_tan(p, x, prec)[source]
+sympy.polys.ring_series.rs_tan(p, x, prec)[source]

Tangent of a series.

Return the series expansion of the tan of p, about 0.

@@ -1082,7 +1082,7 @@

Reference
-sympy.polys.ring_series._tan1(p, x, prec)[source]
+sympy.polys.ring_series._tan1(p, x, prec)[source]

Helper function of rs_tan().

Return the series expansion of tan of a univariate series using Newton’s method. It takes advantage of the fact that series expansion of atan is @@ -1095,7 +1095,7 @@

Reference
-sympy.polys.ring_series.rs_cot(p, x, prec)[source]
+sympy.polys.ring_series.rs_cot(p, x, prec)[source]

Cotangent of a series

Return the series expansion of the cot of p, about 0.

Examples

@@ -1115,7 +1115,7 @@

Reference
-sympy.polys.ring_series.rs_sin(p, x, prec)[source]
+sympy.polys.ring_series.rs_sin(p, x, prec)[source]

Sine of a series

Return the series expansion of the sin of p, about 0.

Examples

@@ -1137,7 +1137,7 @@

Reference
-sympy.polys.ring_series.rs_cos(p, x, prec)[source]
+sympy.polys.ring_series.rs_cos(p, x, prec)[source]

Cosine of a series

Return the series expansion of the cos of p, about 0.

Examples

@@ -1159,14 +1159,14 @@

Reference
-sympy.polys.ring_series.rs_cos_sin(p, x, prec)[source]
+sympy.polys.ring_series.rs_cos_sin(p, x, prec)[source]

Return the tuple (rs_cos(p, x, prec)`, `rs_sin(p, x, prec)).

Is faster than calling rs_cos and rs_sin separately

-sympy.polys.ring_series.rs_atanh(p, x, prec)[source]
+sympy.polys.ring_series.rs_atanh(p, x, prec)[source]

Hyperbolic arctangent of a series

Return the series expansion of the atanh of p, about 0.

Examples

@@ -1186,7 +1186,7 @@

Reference
-sympy.polys.ring_series.rs_sinh(p, x, prec)[source]
+sympy.polys.ring_series.rs_sinh(p, x, prec)[source]

Hyperbolic sine of a series

Return the series expansion of the sinh of p, about 0.

Examples

@@ -1206,7 +1206,7 @@

Reference
-sympy.polys.ring_series.rs_cosh(p, x, prec)[source]
+sympy.polys.ring_series.rs_cosh(p, x, prec)[source]

Hyperbolic cosine of a series

Return the series expansion of the cosh of p, about 0.

Examples

@@ -1226,7 +1226,7 @@

Reference
-sympy.polys.ring_series.rs_tanh(p, x, prec)[source]
+sympy.polys.ring_series.rs_tanh(p, x, prec)[source]

Hyperbolic tangent of a series

Return the series expansion of the tanh of p, about 0.

Examples

@@ -1246,7 +1246,7 @@

Reference
-sympy.polys.ring_series.rs_hadamard_exp(p1, inverse=False)[source]
+sympy.polys.ring_series.rs_hadamard_exp(p1, inverse=False)[source]

Return sum f_i/i!*x**i from sum f_i*x**i, where x is the first variable.

If invers=True return sum f_i*i!*x**i

@@ -1265,7 +1265,7 @@

Reference
-sympy.polys.ring_series.rs_mul(p1, p2, x, prec)[source]
+sympy.polys.ring_series.rs_mul(p1, p2, x, prec)[source]

Return the product of the given two series, modulo O(x**prec).

x is the series variable or its position in the generators.

Examples

@@ -1283,7 +1283,7 @@

Reference
-sympy.polys.ring_series.rs_square(p1, x, prec)[source]
+sympy.polys.ring_series.rs_square(p1, x, prec)[source]

Square the series modulo O(x**prec)

Examples

>>> from sympy.polys.domains import QQ
@@ -1299,7 +1299,7 @@ 

Reference
-sympy.polys.ring_series.rs_pow(p1, n, x, prec)[source]
+sympy.polys.ring_series.rs_pow(p1, n, x, prec)[source]

Return p1**n modulo O(x**prec)

Examples

>>> from sympy.polys.domains import QQ
@@ -1315,7 +1315,7 @@ 

Reference
-sympy.polys.ring_series.rs_series_inversion(p, x, prec)[source]
+sympy.polys.ring_series.rs_series_inversion(p, x, prec)[source]

Multivariate series inversion 1/p modulo O(x**prec).

Examples

>>> from sympy.polys.domains import QQ
@@ -1334,7 +1334,7 @@ 

Reference
-sympy.polys.ring_series.rs_series_reversion(p, x, n, y)[source]
+sympy.polys.ring_series.rs_series_reversion(p, x, n, y)[source]

Reversion of a series.

p is a series with O(x**n) of the form \(p = ax + f(x)\) where \(a\) is a number different from 0.

@@ -1379,7 +1379,7 @@

Reference
-sympy.polys.ring_series.rs_nth_root(p, n, x, prec)[source]
+sympy.polys.ring_series.rs_nth_root(p, n, x, prec)[source]

Multivariate series expansion of the nth root of p.

Parameters:
@@ -1419,7 +1419,7 @@

Reference
-sympy.polys.ring_series.rs_trunc(p1, x, prec)[source]
+sympy.polys.ring_series.rs_trunc(p1, x, prec)[source]

Truncate the series in the x variable with precision prec, that is, modulo O(x**prec)

Examples

@@ -1438,7 +1438,7 @@

Reference
-sympy.polys.ring_series.rs_subs(p, rules, x, prec)[source]
+sympy.polys.ring_series.rs_subs(p, rules, x, prec)[source]

Substitution with truncation according to the mapping in rules.

Return a series with precision prec in the generator x

Note that substitutions are not done one after the other

@@ -1479,7 +1479,7 @@

Reference
-sympy.polys.ring_series.rs_diff(p, x)[source]
+sympy.polys.ring_series.rs_diff(p, x)[source]

Return partial derivative of p with respect to x.

Parameters:
@@ -1500,7 +1500,7 @@

Reference
-sympy.polys.ring_series.rs_integrate(p, x)[source]
+sympy.polys.ring_series.rs_integrate(p, x)[source]

Integrate p with respect to x.

Parameters:
@@ -1521,7 +1521,7 @@

Reference
-sympy.polys.ring_series.rs_newton(p, x, prec)[source]
+sympy.polys.ring_series.rs_newton(p, x, prec)[source]

Compute the truncated Newton sum of the polynomial p

Examples

>>> from sympy.polys.domains import QQ
@@ -1537,7 +1537,7 @@ 

Reference
-sympy.polys.ring_series.rs_compose_add(p1, p2)[source]
+sympy.polys.ring_series.rs_compose_add(p1, p2)[source]

compute the composed sum prod(p2(x - beta) for beta root of p1)

Examples

>>> from sympy.polys.domains import QQ
@@ -1565,7 +1565,7 @@ 

Reference
-sympy.polys.ring_series.rs_is_puiseux(p, x)[source]
+sympy.polys.ring_series.rs_is_puiseux(p, x)[source]

Test if p is Puiseux series in x.

Raise an exception if it has a negative power in x.

Examples

@@ -1582,7 +1582,7 @@

Reference
-sympy.polys.ring_series.rs_puiseux(f, p, x, prec)[source]
+sympy.polys.ring_series.rs_puiseux(f, p, x, prec)[source]

Return the puiseux series for \(f(p, x, prec)\).

To be used when function f is implemented only for regular series.

Examples

@@ -1599,14 +1599,14 @@

Reference
-sympy.polys.ring_series.rs_puiseux2(f, p, q, x, prec)[source]
+sympy.polys.ring_series.rs_puiseux2(f, p, q, x, prec)[source]

Return the puiseux series for \(f(p, q, x, prec)\).

To be used when function f is implemented only for regular series.

-sympy.polys.ring_series.rs_series_from_list(p, c, x, prec, concur=1)[source]
+sympy.polys.ring_series.rs_series_from_list(p, c, x, prec, concur=1)[source]

Return a series \(sum c[n]*p**n\) modulo \(O(x**prec)\).

It reduces the number of multiplications by summing concurrently.

\(ax = [1, p, p**2, .., p**(J - 1)]\) @@ -1632,7 +1632,7 @@

Reference
-sympy.polys.ring_series.rs_fun(p, f, *args)[source]
+sympy.polys.ring_series.rs_fun(p, f, *args)[source]

Function of a multivariate series computed by substitution.

The case with f method name is used to compute \(rs\_tan\) and \(rs\_nth\_root\) of a multivariate series:

@@ -1664,14 +1664,14 @@

Reference
-sympy.polys.ring_series.mul_xin(p, i, n)[source]
+sympy.polys.ring_series.mul_xin(p, i, n)[source]

Return \(p*x_i**n\).

\(x\_i\) is the ith variable in p.

-sympy.polys.ring_series.pow_xin(p, i, n)[source]
+sympy.polys.ring_series.pow_xin(p, i, n)[source]
>>> from sympy.polys.domains import QQ
 >>> from sympy.polys.rings import ring
 >>> from sympy.polys.ring_series import pow_xin
diff --git a/dev/modules/polys/solvers.html b/dev/modules/polys/solvers.html
index 0ca270b5549..a71c14a0992 100644
--- a/dev/modules/polys/solvers.html
+++ b/dev/modules/polys/solvers.html
@@ -808,7 +808,7 @@ 
Documentation Version

Low-level linear systems solver.

-sympy.polys.solvers.solve_lin_sys(eqs, ring, _raw=True)[source]
+sympy.polys.solvers.solve_lin_sys(eqs, ring, _raw=True)[source]

Solve a system of linear equations from a PolynomialRing

Parameters:
@@ -877,7 +877,7 @@
Documentation Version
-sympy.polys.solvers.eqs_to_matrix(eqs_coeffs, eqs_rhs, gens, domain)[source]
+sympy.polys.solvers.eqs_to_matrix(eqs_coeffs, eqs_rhs, gens, domain)[source]

Get matrix from linear equations in dict format.

Parameters:
@@ -930,7 +930,7 @@
Documentation Version
-sympy.polys.solvers.sympy_eqs_to_ring(eqs, symbols)[source]
+sympy.polys.solvers.sympy_eqs_to_ring(eqs, symbols)[source]

Convert a system of equations from Expr to a PolyRing

Parameters:
@@ -978,7 +978,7 @@
Documentation Version
-sympy.polys.solvers._solve_lin_sys(eqs_coeffs, eqs_rhs, ring)[source]
+sympy.polys.solvers._solve_lin_sys(eqs_coeffs, eqs_rhs, ring)[source]

Solve a linear system from dict of PolynomialRing coefficients

Explanation

This is an internal function used by solve_lin_sys() after the @@ -1016,7 +1016,7 @@

Documentation Version
ring,
-)[source] +)[source]

Solve a linear system from dict of PolynomialRing coefficients

Explanation

This is an internal function used by solve_lin_sys() after the diff --git a/dev/modules/printing.html b/dev/modules/printing.html index c98c17af6b5..7813eb18022 100644 --- a/dev/modules/printing.html +++ b/dev/modules/printing.html @@ -1015,7 +1015,7 @@

Common mistakessource code):

-class sympy.printing.printer.Printer(settings=None)[source]
+class sympy.printing.printer.Printer(settings=None)[source]

Generic printer

Its job is to provide infrastructure for implementing new printers easily.

If you want to define your custom Printer or your custom printing method @@ -1027,7 +1027,7 @@

Common mistakes
-_print(expr, **kwargs) str[source]
+_print(expr, **kwargs) str[source]

Internal dispatcher

Tries the following concepts to print an expression:
    @@ -1041,13 +1041,13 @@

    Common mistakes
    -doprint(expr)[source]
    +doprint(expr)[source]

    Returns printer’s representation for expr (as a string)

-classmethod set_global_settings(**settings)[source]
+classmethod set_global_settings(**settings)[source]

Set system-wide printing settings.

@@ -1069,7 +1069,7 @@

PrettyPrinter Class
-class sympy.printing.pretty.pretty.PrettyPrinter(settings=None)[source]
+class sympy.printing.pretty.pretty.PrettyPrinter(settings=None)[source]

Printer, which converts an expression into 2D ASCII-art figure.

@@ -1104,7 +1104,7 @@

PrettyPrinter Class
-sympy.printing.pretty.pretty.pretty_print(expr, **kwargs)[source]
+sympy.printing.pretty.pretty.pretty_print(expr, **kwargs)[source]

Prints expr in pretty form.

pprint is just a shortcut for this function.

@@ -1189,7 +1189,7 @@

PrettyPrinter Class
-class sympy.printing.c.C89CodePrinter(settings=None)[source]
+class sympy.printing.c.C89CodePrinter(settings=None)[source]

A printer to convert Python expressions to strings of C code

@@ -1198,7 +1198,7 @@

PrettyPrinter Class
-indent_code(code)[source]
+indent_code(code)[source]

Accepts a string of code or a list of code lines

@@ -1206,7 +1206,7 @@

PrettyPrinter Class
-class sympy.printing.c.C99CodePrinter(settings=None)[source]
+class sympy.printing.c.C99CodePrinter(settings=None)[source]
printmethod: str = '_ccode'
@@ -1225,7 +1225,7 @@

PrettyPrinter Class**settings,

-)[source] +)[source]

Converts an expr to a string of c code

Parameters:
@@ -1373,7 +1373,7 @@

PrettyPrinter Class
-sympy.printing.c.print_ccode(expr, **settings)[source]
+sympy.printing.c.print_ccode(expr, **settings)[source]

Prints C representation of the given expression.

@@ -1392,7 +1392,7 @@

PrettyPrinter Class
-class sympy.printing.cxx.CXX98CodePrinter(settings=None)[source]
+class sympy.printing.cxx.CXX98CodePrinter(settings=None)[source]
printmethod: str = '_cxxcode'
@@ -1402,7 +1402,7 @@

PrettyPrinter Class
-class sympy.printing.cxx.CXX11CodePrinter(settings=None)[source]
+class sympy.printing.cxx.CXX11CodePrinter(settings=None)[source]
printmethod: str = '_cxxcode'
@@ -1421,7 +1421,7 @@

PrettyPrinter Class**settings,

-)[source] +)[source]

C++ equivalent of ccode().

@@ -1449,7 +1449,7 @@

PrettyPrinter Class
-class sympy.printing.rcode.RCodePrinter(settings={})[source]
+class sympy.printing.rcode.RCodePrinter(settings={})[source]

A printer to convert SymPy expressions to strings of R code

@@ -1458,7 +1458,7 @@

PrettyPrinter Class
-indent_code(code)[source]
+indent_code(code)[source]

Accepts a string of code or a list of code lines

@@ -1466,7 +1466,7 @@

PrettyPrinter Class
-sympy.printing.rcode.rcode(expr, assign_to=None, **settings)[source]
+sympy.printing.rcode.rcode(expr, assign_to=None, **settings)[source]

Converts an expr to a string of r code

Parameters:
@@ -1585,7 +1585,7 @@

PrettyPrinter Class
-sympy.printing.rcode.print_rcode(expr, **settings)[source]
+sympy.printing.rcode.print_rcode(expr, **settings)[source]

Prints R representation of the given expression.

@@ -1600,7 +1600,7 @@

Fortran Printing
-sympy.printing.fortran.fcode(expr, assign_to=None, **settings)[source]
+sympy.printing.fortran.fcode(expr, assign_to=None, **settings)[source]

Converts an expr to a string of fortran code

Parameters:
@@ -1736,14 +1736,14 @@

Fortran Printing
-sympy.printing.fortran.print_fcode(expr, **settings)[source]
+sympy.printing.fortran.print_fcode(expr, **settings)[source]

Prints the Fortran representation of the given expression.

See fcode for the meaning of the optional arguments.

-class sympy.printing.fortran.FCodePrinter(settings=None)[source]
+class sympy.printing.fortran.FCodePrinter(settings=None)[source]

A printer to convert SymPy expressions to strings of Fortran code

@@ -1752,7 +1752,7 @@

Fortran Printing
-indent_code(code)[source]
+indent_code(code)[source]

Accepts a string of code or a list of code lines

@@ -1886,7 +1886,7 @@

Fortran Printingsymbol_table=None,

-)[source] +)[source]
printmethod: str = '_smtlib'
@@ -1917,7 +1917,7 @@

Fortran Printinglog_warn=None,

-)[source] +)[source]

Converts expr to a string of smtlib code.

Parameters:
@@ -2032,7 +2032,7 @@

Fortran Printing
-class sympy.printing.mathematica.MCodePrinter(settings={})[source]
+class sympy.printing.mathematica.MCodePrinter(settings={})[source]

A printer to convert Python expressions to strings of the Wolfram’s Mathematica code

@@ -2044,7 +2044,7 @@

Fortran Printing
-sympy.printing.mathematica.mathematica_code(expr, **settings)[source]
+sympy.printing.mathematica.mathematica_code(expr, **settings)[source]

Converts an expr to a string of the Wolfram Mathematica code

Examples

>>> from sympy import mathematica_code as mcode, symbols, sin
@@ -2060,7 +2060,7 @@ 

Fortran Printing

Maple code printing

-class sympy.printing.maple.MapleCodePrinter(settings=None)[source]
+class sympy.printing.maple.MapleCodePrinter(settings=None)[source]

Printer which converts a SymPy expression into a maple code.

@@ -2071,7 +2071,7 @@

Fortran Printing
-sympy.printing.maple.maple_code(expr, assign_to=None, **settings)[source]
+sympy.printing.maple.maple_code(expr, assign_to=None, **settings)[source]

Converts expr to a string of Maple code.

Parameters:
@@ -2123,7 +2123,7 @@

Fortran Printing
-sympy.printing.maple.print_maple_code(expr, **settings)[source]
+sympy.printing.maple.print_maple_code(expr, **settings)[source]

Prints the Maple representation of the given expression.

See maple_code() for the meaning of the optional arguments.

Examples

@@ -2145,7 +2145,7 @@

Fortran Printing
-class sympy.printing.jscode.JavascriptCodePrinter(settings={})[source]
+class sympy.printing.jscode.JavascriptCodePrinter(settings={})[source]

“A Printer to convert Python expressions to strings of JavaScript code

@@ -2154,7 +2154,7 @@

Fortran Printing
-indent_code(code)[source]
+indent_code(code)[source]

Accepts a string of code or a list of code lines

@@ -2162,7 +2162,7 @@

Fortran Printing
-sympy.printing.jscode.jscode(expr, assign_to=None, **settings)[source]
+sympy.printing.jscode.jscode(expr, assign_to=None, **settings)[source]

Converts an expr to a string of javascript code

Parameters:
@@ -2296,7 +2296,7 @@

Fortran Printing
-class sympy.printing.julia.JuliaCodePrinter(settings={})[source]
+class sympy.printing.julia.JuliaCodePrinter(settings={})[source]

A printer to convert expressions to strings of Julia code.

@@ -2305,7 +2305,7 @@

Fortran Printing
-indent_code(code)[source]
+indent_code(code)[source]

Accepts a string of code or a list of code lines

@@ -2313,7 +2313,7 @@

Fortran Printing
-sympy.printing.julia.julia_code(expr, assign_to=None, **settings)[source]
+sympy.printing.julia.julia_code(expr, assign_to=None, **settings)[source]

Converts \(expr\) to a string of Julia code.

Parameters:
@@ -2480,7 +2480,7 @@

Fortran Printing
-class sympy.printing.octave.OctaveCodePrinter(settings={})[source]
+class sympy.printing.octave.OctaveCodePrinter(settings={})[source]

A printer to convert expressions to strings of Octave/Matlab code.

@@ -2489,7 +2489,7 @@

Fortran Printing
-indent_code(code)[source]
+indent_code(code)[source]

Accepts a string of code or a list of code lines

@@ -2497,7 +2497,7 @@

Fortran Printing
-sympy.printing.octave.octave_code(expr, assign_to=None, **settings)[source]
+sympy.printing.octave.octave_code(expr, assign_to=None, **settings)[source]

Converts \(expr\) to a string of Octave (or Matlab) code.

The string uses a subset of the Octave language for Matlab compatibility.

@@ -2657,7 +2657,7 @@

Fortran Printing
-class sympy.printing.rust.RustCodePrinter(settings={})[source]
+class sympy.printing.rust.RustCodePrinter(settings={})[source]

A printer to convert SymPy expressions to strings of Rust code

@@ -2666,7 +2666,7 @@

Fortran Printing
-indent_code(code)[source]
+indent_code(code)[source]

Accepts a string of code or a list of code lines

@@ -2674,7 +2674,7 @@

Fortran Printing
-sympy.printing.codeprinter.rust_code(expr, assign_to=None, **settings)[source]
+sympy.printing.codeprinter.rust_code(expr, assign_to=None, **settings)[source]

Converts an expr to a string of Rust code

Parameters:
@@ -2801,7 +2801,7 @@

Fortran Printing

Aesara Code printing

-class sympy.printing.aesaracode.AesaraPrinter(*args, **kwargs)[source]
+class sympy.printing.aesaracode.AesaraPrinter(*args, **kwargs)[source]

Code printer which creates Aesara symbolic expression graphs.

Parameters:
@@ -2842,7 +2842,7 @@

Fortran Printingbroadcastables=None,

-)[source] +)[source]

Convert a SymPy expression to a Aesara graph variable.

The dtypes and broadcastables arguments are used to specify the data type, dimension, and broadcasting behavior of the Aesara variables @@ -2886,7 +2886,7 @@

Fortran Printing
-sympy.printing.aesaracode.aesara_code(expr, cache=None, **kwargs)[source]
+sympy.printing.aesaracode.aesara_code(expr, cache=None, **kwargs)[source]

Convert a SymPy expression into a Aesara graph variable.

Parameters:
@@ -2932,7 +2932,7 @@

Fortran Printing**kwargs,

-)[source] +)[source]

Create a Aesara function from SymPy expressions.

The inputs and outputs are converted to Aesara variables using aesara_code() and then passed to aesara.function.

@@ -3036,7 +3036,7 @@

Fortran Printingbroadcastables=None,

-)[source] +)[source]

Get value of broadcastables argument to aesara_code() from keyword arguments to aesara_function().

Included for backwards compatibility.

@@ -3087,7 +3087,7 @@

Fortran Printing
-sympy.printing.gtk.print_gtk(x, start_viewer=True)[source]
+sympy.printing.gtk.print_gtk(x, start_viewer=True)[source]

Print to Gtkmathview, a gtk widget capable of rendering MathML.

Needs libgtkmathview-bin

@@ -3099,7 +3099,7 @@

Fortran Printingsympy.utilities.lambdify.lambdify() function.

-class sympy.printing.lambdarepr.LambdaPrinter(settings=None)[source]
+class sympy.printing.lambdarepr.LambdaPrinter(settings=None)[source]

This printer converts expressions into strings that can be used by lambdify.

@@ -3111,7 +3111,7 @@

Fortran Printing
-sympy.printing.lambdarepr.lambdarepr(expr, **settings)[source]
+sympy.printing.lambdarepr.lambdarepr(expr, **settings)[source]

Returns a string usable for lambdifying.

@@ -3129,7 +3129,7 @@

Fortran Printing
-class sympy.printing.latex.LatexPrinter(settings=None)[source]
+class sympy.printing.latex.LatexPrinter(settings=None)[source]
printmethod: str = '_latex'
@@ -3137,7 +3137,7 @@

Fortran Printing
-parenthesize_super(s)[source]
+parenthesize_super(s)[source]

Protect superscripts in s

If the parenthesize_super option is set, protect with parentheses, else wrap in braces.

@@ -3440,7 +3440,7 @@

Fortran Printing
-sympy.printing.latex.print_latex(expr, **settings)[source]
+sympy.printing.latex.print_latex(expr, **settings)[source]

Prints LaTeX representation of the given expression. Takes the same settings as latex().

@@ -3452,12 +3452,12 @@

Fortran Printinghttps://www.w3.org/TR/MathML2

-class sympy.printing.mathml.MathMLPrinterBase(settings=None)[source]
+class sympy.printing.mathml.MathMLPrinterBase(settings=None)[source]

Contains common code required for MathMLContentPrinter and MathMLPresentationPrinter.

-doprint(expr)[source]
+doprint(expr)[source]

Prints the expression as MathML.

@@ -3465,7 +3465,7 @@

Fortran Printing
-class sympy.printing.mathml.MathMLContentPrinter(settings=None)[source]
+class sympy.printing.mathml.MathMLContentPrinter(settings=None)[source]

Prints an expression to the Content MathML markup language.

References: https://www.w3.org/TR/MathML2/chapter4.html

@@ -3475,7 +3475,7 @@

Fortran Printing
-mathml_tag(e)[source]
+mathml_tag(e)[source]

Returns the MathML tag for an expression.

@@ -3483,7 +3483,7 @@

Fortran Printing
-class sympy.printing.mathml.MathMLPresentationPrinter(settings=None)[source]
+class sympy.printing.mathml.MathMLPresentationPrinter(settings=None)[source]

Prints an expression to the Presentation MathML markup language.

References: https://www.w3.org/TR/MathML2/chapter3.html

@@ -3493,7 +3493,7 @@

Fortran Printing
-mathml_tag(e)[source]
+mathml_tag(e)[source]

Returns the MathML tag for an expression.

@@ -3530,7 +3530,7 @@

Fortran Printing
-sympy.printing.mathml.print_mathml(expr, printer='content', **settings)[source]
+sympy.printing.mathml.print_mathml(expr, printer='content', **settings)[source]

Prints a pretty representation of the MathML code for expr. If printer is presentation then prints Presentation MathML else prints content MathML.

Examples

@@ -3560,13 +3560,13 @@

Fortran Printing
-class sympy.printing.pycode.MpmathPrinter(settings=None)[source]
+class sympy.printing.pycode.MpmathPrinter(settings=None)[source]

Lambda printer for mpmath which maintains precision for floats

-sympy.printing.pycode.pycode(expr, **settings)[source]
+sympy.printing.pycode.pycode(expr, **settings)[source]

Converts an expr to a string of Python code

Parameters:
@@ -3628,7 +3628,7 @@

Fortran Printingstr() or print().

-class sympy.printing.repr.ReprPrinter(settings=None)[source]
+class sympy.printing.repr.ReprPrinter(settings=None)[source]
printmethod: str = '_sympyrepr'
@@ -3636,13 +3636,13 @@

Fortran Printing
-emptyPrinter(expr)[source]
+emptyPrinter(expr)[source]

The fallback printer.

-reprify(args, sep)[source]
+reprify(args, sep)[source]

Prints each item in \(args\) and joins them with \(sep\).

@@ -3660,7 +3660,7 @@

Fortran Printing
-class sympy.printing.str.StrPrinter(settings=None)[source]
+class sympy.printing.str.StrPrinter(settings=None)[source]
printmethod: str = '_sympystr'
@@ -3730,7 +3730,7 @@

Fortran Printing
-sympy.printing.tree.pprint_nodes(subtrees)[source]
+sympy.printing.tree.pprint_nodes(subtrees)[source]

Prettyprints systems of nodes.

Examples

>>> from sympy.printing.tree import pprint_nodes
@@ -3745,7 +3745,7 @@ 

Fortran Printing
-sympy.printing.tree.print_node(node, assumptions=True)[source]
+sympy.printing.tree.print_node(node, assumptions=True)[source]

Returns information about the “node”.

This includes class name, string representation and assumptions.

@@ -3760,7 +3760,7 @@

Fortran Printing
-sympy.printing.tree.tree(node, assumptions=True)[source]
+sympy.printing.tree.tree(node, assumptions=True)[source]

Returns a tree representation of “node” as a string.

It uses print_node() together with pprint_nodes() on node.args recursively.

@@ -3784,7 +3784,7 @@

Fortran Printing
-sympy.printing.tree.print_tree(node, assumptions=True)[source]
+sympy.printing.tree.print_tree(node, assumptions=True)[source]

Prints a tree representation of “node”.

Parameters:
@@ -3885,7 +3885,7 @@

Preview
**latex_settings,

-)[source] +)[source]

View expression or LaTeX markup in PNG, DVI, PostScript or PDF form.

If the expr argument is an expression, it will be exported to LaTeX and then compiled using the available TeX distribution. The first argument, @@ -3984,7 +3984,7 @@

Preview

Implementation - Helper Classes/Functions

-sympy.printing.conventions.split_super_sub(text)[source]
+sympy.printing.conventions.split_super_sub(text)[source]

Split a symbol name into a name, superscripts and subscripts

The first part of the symbol name is considered to be its actual ‘name’, followed by super- and subscripts. Each superscript is @@ -4008,7 +4008,7 @@

Preview¶ easily translated to C or Fortran.

-class sympy.printing.codeprinter.CodePrinter(settings=None)[source]
+class sympy.printing.codeprinter.CodePrinter(settings=None)[source]

The base class for code-printing subclasses.

@@ -4017,7 +4017,7 @@

Preview
-doprint(expr, assign_to=None)[source]
+doprint(expr, assign_to=None)[source]

Print the expression as code.

Parameters:
@@ -4038,7 +4038,7 @@

Preview
-exception sympy.printing.codeprinter.AssignmentError[source]
+exception sympy.printing.codeprinter.AssignmentError[source]

Raised if an assignment variable for a loop is missing.

@@ -4070,7 +4070,7 @@

Preview
-sympy.printing.precedence.precedence(item)[source]
+sympy.printing.precedence.precedence(item)[source]

Returns the precedence of a given object.

This is the precedence for StrPrinter.

@@ -4081,38 +4081,38 @@

Preview

Pretty-Printing Implementation Helpers

-sympy.printing.pretty.pretty_symbology.U(name)[source]
+sympy.printing.pretty.pretty_symbology.U(name)[source]

Get a unicode character by name or, None if not found.

This exists because older versions of Python use older unicode databases.

-sympy.printing.pretty.pretty_symbology.pretty_use_unicode(flag=None)[source]
+sympy.printing.pretty.pretty_symbology.pretty_use_unicode(flag=None)[source]

Set whether pretty-printer should use unicode by default

-sympy.printing.pretty.pretty_symbology.pretty_try_use_unicode()[source]
+sympy.printing.pretty.pretty_symbology.pretty_try_use_unicode()[source]

See if unicode output is available and leverage it if possible

-sympy.printing.pretty.pretty_symbology.xstr(*args)[source]
+sympy.printing.pretty.pretty_symbology.xstr(*args)[source]

The following two functions return the Unicode version of the inputted Greek letter.

-sympy.printing.pretty.pretty_symbology.g(l)[source]
+sympy.printing.pretty.pretty_symbology.g(l)[source]
-sympy.printing.pretty.pretty_symbology.G(l)[source]
+sympy.printing.pretty.pretty_symbology.G(l)[source]
@@ -4148,21 +4148,21 @@

Preview

The following functions return Unicode vertical objects.

-sympy.printing.pretty.pretty_symbology.xobj(symb, length)[source]
+sympy.printing.pretty.pretty_symbology.xobj(symb, length)[source]

Construct spatial object of given length.

return: [] of equal-length strings

-sympy.printing.pretty.pretty_symbology.vobj(symb, height)[source]
+sympy.printing.pretty.pretty_symbology.vobj(symb, height)[source]

Construct vertical object of a given height

see: xobj

-sympy.printing.pretty.pretty_symbology.hobj(symb, width)[source]
+sympy.printing.pretty.pretty_symbology.hobj(symb, width)[source]

Construct horizontal object of a given width

see: xobj

@@ -4175,7 +4175,7 @@

Preview
-sympy.printing.pretty.pretty_symbology.VF(txt)[source]
+sympy.printing.pretty.pretty_symbology.VF(txt)[source]
@@ -4186,7 +4186,7 @@

Preview

The following constants/functions are for rendering atoms and symbols.

-sympy.printing.pretty.pretty_symbology.xsym(sym)[source]
+sympy.printing.pretty.pretty_symbology.xsym(sym)[source]

get symbology for a ‘character’

@@ -4197,19 +4197,19 @@

Preview
-sympy.printing.pretty.pretty_symbology.pretty_atom(atom_name, default=None, printer=None)[source]
+sympy.printing.pretty.pretty_symbology.pretty_atom(atom_name, default=None, printer=None)[source]

return pretty representation of an atom

-sympy.printing.pretty.pretty_symbology.pretty_symbol(symb_name, bold_name=False)[source]
+sympy.printing.pretty.pretty_symbology.pretty_symbol(symb_name, bold_name=False)[source]

return pretty representation of a symbol

-sympy.printing.pretty.pretty_symbology.annotated(letter)[source]
+sympy.printing.pretty.pretty_symbology.annotated(letter)[source]

Return a stylised drawing of the letter letter, together with information on how to put annotations (super- and subscripts to the left and to the right) on it.

@@ -4235,12 +4235,12 @@

Preview

-class sympy.printing.pretty.stringpict.stringPict(s, baseline=0)[source]
+class sympy.printing.pretty.stringpict.stringPict(s, baseline=0)[source]

An ASCII picture. The pictures are represented as a list of equal length strings.

-above(*args)[source]
+above(*args)[source]

Put pictures above this picture. Returns string, baseline arguments for stringPict. Baseline is baseline of bottom picture.

@@ -4248,7 +4248,7 @@

Preview
-below(*args)[source]
+below(*args)[source]

Put pictures under this picture. Returns string, baseline arguments for stringPict. Baseline is baseline of top picture

@@ -4265,26 +4265,26 @@

Preview
-height()[source]
+height()[source]

The height of the picture in characters.

-left(*args)[source]
+left(*args)[source]

Put pictures (left to right) at left. Returns string, baseline arguments for stringPict.

-leftslash()[source]
+leftslash()[source]

Precede object by a slash of the proper size.

-static next(*args)[source]
+static next(*args)[source]

Put a string of stringPicts next to each other. Returns string, baseline arguments for stringPict.

@@ -4299,7 +4299,7 @@

Preview
ifascii_nougly=False,

-)[source] +)[source]

Put parentheses around self. Returns string, baseline arguments for stringPict.

left or right can be None or empty string which means ‘no paren from @@ -4308,7 +4308,7 @@

Preview
-render(*args, **kwargs)[source]
+render(*args, **kwargs)[source]

Return the string form of self.

Unless the argument line_break is set to False, it will break the expression in a form that can be printed @@ -4317,7 +4317,7 @@

Preview
-right(*args)[source]
+right(*args)[source]

Put pictures next to this one. Returns string, baseline arguments for stringPict. (Multiline) strings are allowed, and are given a baseline of 0.

@@ -4333,14 +4333,14 @@

Preview
-root(n=None)[source]
+root(n=None)[source]

Produce a nice root symbol. Produces ugly results for big n inserts.

-static stack(*args)[source]
+static stack(*args)[source]

Put pictures on top of each other, from top to bottom. Returns string, baseline arguments for stringPict. @@ -4353,13 +4353,13 @@

Preview
-terminal_width()[source]
+terminal_width()[source]

Return the terminal width if possible, otherwise return 0.

-width()[source]
+width()[source]

The width of the picture in characters.

@@ -4367,7 +4367,7 @@

Preview
-class sympy.printing.pretty.stringpict.prettyForm(s, baseline=0, binding=0, unicode=None)[source]
+class sympy.printing.pretty.stringpict.prettyForm(s, baseline=0, binding=0, unicode=None)[source]

Extension of the stringPict class that knows about basic math applications, optimizing double minus signs.

“Binding” is interpreted as follows:

@@ -4385,7 +4385,7 @@

Preview

-static apply(function, *args)[source]
+static apply(function, *args)[source]

Functions of one or more variables.

@@ -4412,7 +4412,7 @@

dotprint
**kwargs,

-)[source] +)[source]

DOT description of a SymPy expression tree

Parameters:
diff --git a/dev/modules/rewriting.html b/dev/modules/rewriting.html index 0e8adafa295..83b142e6a4c 100644 --- a/dev/modules/rewriting.html +++ b/dev/modules/rewriting.html @@ -917,7 +917,7 @@

Common Subexpression Detection and Collectionlist=True,

-)[source] +)[source]

Perform common subexpression elimination on an expression.

Parameters:
diff --git a/dev/modules/series/formal.html b/dev/modules/series/formal.html index 00c57257235..192fe6e5c6c 100644 --- a/dev/modules/series/formal.html +++ b/dev/modules/series/formal.html @@ -806,7 +806,7 @@

Formal Power Series
-class sympy.series.formal.FormalPowerSeries(*args)[source]
+class sympy.series.formal.FormalPowerSeries(*args)[source]

Represents Formal Power Series of a function.

Explanation

No computation is performed. This class should only to be used to represent @@ -818,7 +818,7 @@

Formal Power Series
-coeff_bell(n)[source]
+coeff_bell(n)[source]

self.coeff_bell(n) returns a sequence of Bell polynomials of the second kind. Note that n should be a integer.

The second kind of Bell polynomials (are sometimes called “partial” Bell @@ -844,7 +844,7 @@

Formal Power Series
-compose(other, x=None, n=6)[source]
+compose(other, x=None, n=6)[source]

Returns the truncated terms of the formal power series of the composed function, up to specified n.

@@ -900,7 +900,7 @@

Formal Power Series
-integrate(x=None, **kwargs)[source]
+integrate(x=None, **kwargs)[source]

Integrate Formal Power Series.

Examples

>>> from sympy import fps, sin, integrate
@@ -916,7 +916,7 @@ 

Formal Power Series
-inverse(x=None, n=6)[source]
+inverse(x=None, n=6)[source]

Returns the truncated terms of the inverse of the formal power series, up to specified n.

@@ -966,7 +966,7 @@

Formal Power Series
-polynomial(n=6)[source]
+polynomial(n=6)[source]

Truncated series as polynomial.

Explanation

Returns series expansion of f upto order O(x**n) @@ -975,7 +975,7 @@

Formal Power Series
-product(other, x=None, n=6)[source]
+product(other, x=None, n=6)[source]

Multiplies two Formal Power Series, using discrete convolution and return the truncated terms upto specified order.

@@ -1006,7 +1006,7 @@

Formal Power Series
-truncate(n=6)[source]
+truncate(n=6)[source]

Truncated series.

Explanation

Returns truncated series expansion of f upto @@ -1031,7 +1031,7 @@

Formal Power Seriesfull=False,

-)[source] +)[source]

Generates Formal Power Series of f.

Parameters:
@@ -1119,7 +1119,7 @@

Formal Power Seriesfull=False,

-)[source] +)[source]

Computes the formula for Formal Power Series of a function.

Parameters:
@@ -1189,7 +1189,7 @@

Formal Power Series
-class sympy.series.formal.FormalPowerSeriesCompose(*args)[source]
+class sympy.series.formal.FormalPowerSeriesCompose(*args)[source]

Represents the composed formal power series of two functions.

Explanation

No computation is performed. Terms are calculated using a term by term logic, @@ -1214,7 +1214,7 @@

Formal Power Series
-class sympy.series.formal.FormalPowerSeriesInverse(*args)[source]
+class sympy.series.formal.FormalPowerSeriesInverse(*args)[source]

Represents the Inverse of a formal power series.

Explanation

No computation is performed. Terms are calculated using a term by term logic, @@ -1237,7 +1237,7 @@

Formal Power Series
-class sympy.series.formal.FormalPowerSeriesProduct(*args)[source]
+class sympy.series.formal.FormalPowerSeriesProduct(*args)[source]

Represents the product of two formal power series of two functions.

Explanation

No computation is performed. Terms are calculated using a term by term logic, @@ -1260,7 +1260,7 @@

Formal Power Series
-class sympy.series.formal.FiniteFormalPowerSeries(*args)[source]
+class sympy.series.formal.FiniteFormalPowerSeries(*args)[source]

Base Class for Product, Compose and Inverse classes

@@ -1268,7 +1268,7 @@

Formal Power Series

-sympy.series.formal.rational_independent(terms, x)[source]
+sympy.series.formal.rational_independent(terms, x)[source]

Returns a list of all the rationally independent terms.

Examples

>>> from sympy import sin, cos
@@ -1286,7 +1286,7 @@ 

Rational Algorithm
-sympy.series.formal.rational_algorithm(f, x, k, order=4, full=False)[source]
+sympy.series.formal.rational_algorithm(f, x, k, order=4, full=False)[source]

Rational algorithm for computing formula of coefficients of Formal Power Series of a function.

@@ -1362,7 +1362,7 @@

Rational Algorithm

-sympy.series.formal.simpleDE(f, x, g, order=4)[source]
+sympy.series.formal.simpleDE(f, x, g, order=4)[source]

Generates simple DE.

Explanation

DE is of the form

@@ -1378,7 +1378,7 @@

Hypergeometric Algorithm
-sympy.series.formal.exp_re(DE, r, k)[source]
+sympy.series.formal.exp_re(DE, r, k)[source]

Converts a DE with constant coefficients (explike) into a RE.

Explanation

Performs the substitution:

@@ -1408,7 +1408,7 @@

Hypergeometric Algorithm
-sympy.series.formal.hyper_re(DE, r, k)[source]
+sympy.series.formal.hyper_re(DE, r, k)[source]

Converts a DE into a RE.

Explanation

Performs the substitution:

@@ -1438,7 +1438,7 @@

Hypergeometric Algorithm
-sympy.series.formal.rsolve_hypergeometric(f, x, P, Q, k, m)[source]
+sympy.series.formal.rsolve_hypergeometric(f, x, P, Q, k, m)[source]

Solves RE of hypergeometric type.

Returns:
@@ -1494,7 +1494,7 @@

Hypergeometric Algorithm
-sympy.series.formal.solve_de(f, x, DE, order, g, k)[source]
+sympy.series.formal.solve_de(f, x, DE, order, g, k)[source]

Solves the DE.

Returns:
@@ -1530,7 +1530,7 @@

Hypergeometric Algorithm
-sympy.series.formal.hyper_algorithm(f, x, k, order=4)[source]
+sympy.series.formal.hyper_algorithm(f, x, k, order=4)[source]

Hypergeometric algorithm for computing Formal Power Series.

Explanation

diff --git a/dev/modules/series/fourier.html b/dev/modules/series/fourier.html index f816e3ffeb7..17806d884ee 100644 --- a/dev/modules/series/fourier.html +++ b/dev/modules/series/fourier.html @@ -806,7 +806,7 @@

Fourier Series
-class sympy.series.fourier.FourierSeries(*args)[source]
+class sympy.series.fourier.FourierSeries(*args)[source]

Represents Fourier sine/cosine series.

Explanation

This class only represents a fourier series. @@ -819,7 +819,7 @@

Fourier Series
-scale(s)[source]
+scale(s)[source]

Scale the function by a term independent of x.

Explanation

f(x) -> s * f(x)

@@ -837,7 +837,7 @@

Fourier Series
-scalex(s)[source]
+scalex(s)[source]

Scale x by a term independent of x.

Explanation

f(x) -> f(s*x)

@@ -855,7 +855,7 @@

Fourier Series
-shift(s)[source]
+shift(s)[source]

Shift the function by a term independent of x.

Explanation

f(x) -> f(x) + s

@@ -873,7 +873,7 @@

Fourier Series
-shiftx(s)[source]
+shiftx(s)[source]

Shift x by a term independent of x.

Explanation

f(x) -> f(x + s)

@@ -891,7 +891,7 @@

Fourier Series
-sigma_approximation(n=3)[source]
+sigma_approximation(n=3)[source]

Return \(\sigma\)-approximation of Fourier series with respect to order n.

@@ -958,7 +958,7 @@

Fourier Series
-truncate(n=3)[source]
+truncate(n=3)[source]

Return the first n nonzero terms of the series.

If n is None return an iterator.

@@ -993,7 +993,7 @@

Fourier Series
-sympy.series.fourier.fourier_series(f, limits=None, finite=True)[source]
+sympy.series.fourier.fourier_series(f, limits=None, finite=True)[source]

Computes the Fourier trigonometric series expansion.

Parameters:
diff --git a/dev/modules/series/limitseq.html b/dev/modules/series/limitseq.html index 7aaa6cf2e6c..06e57bddf0b 100644 --- a/dev/modules/series/limitseq.html +++ b/dev/modules/series/limitseq.html @@ -806,7 +806,7 @@

Limits of Sequences
-sympy.series.limitseq.difference_delta(expr, n=None, step=1)[source]
+sympy.series.limitseq.difference_delta(expr, n=None, step=1)[source]

Difference Operator.

Explanation

Discrete analog of differential operator. Given a sequence x[n], @@ -831,7 +831,7 @@

Limits of Sequences
-sympy.series.limitseq.dominant(expr, n)[source]
+sympy.series.limitseq.dominant(expr, n)[source]

Finds the dominant term in a sum, that is a term that dominates every other term.

Explanation

@@ -857,7 +857,7 @@

Limits of Sequences
-sympy.series.limitseq.limit_seq(expr, n=None, trials=5)[source]
+sympy.series.limitseq.limit_seq(expr, n=None, trials=5)[source]

Finds the limit of a sequence as index n tends to infinity.

Parameters:
diff --git a/dev/modules/series/sequences.html b/dev/modules/series/sequences.html index 89bf40355e3..5681e8f876f 100644 --- a/dev/modules/series/sequences.html +++ b/dev/modules/series/sequences.html @@ -806,7 +806,7 @@

Sequences
-sympy.series.sequences.sequence(seq, limits=None)[source]
+sympy.series.sequences.sequence(seq, limits=None)[source]

Returns appropriate sequence object.

Explanation

If seq is a SymPy sequence, returns SeqPer object @@ -830,17 +830,17 @@

Sequences

-class sympy.series.sequences.SeqBase(*args)[source]
+class sympy.series.sequences.SeqBase(*args)[source]

Base class for sequences

-coeff(pt)[source]
+coeff(pt)[source]

Returns the coefficient at point pt

-coeff_mul(other)[source]
+coeff_mul(other)[source]

Should be used when other is not a sequence. Should be defined to define custom behaviour.

Examples

@@ -864,7 +864,7 @@

Sequences Basegfvar=None,

-)[source] +)[source]

Finds the shortest linear recurrence that satisfies the first n terms of sequence of order \(\leq\) n/2 if possible. If d is specified, find shortest linear recurrence of order @@ -954,7 +954,7 @@

Sequences Base

-class sympy.series.sequences.SeqFormula(formula, limits=None)[source]
+class sympy.series.sequences.SeqFormula(formula, limits=None)[source]

Represents sequence based on a formula.

Elements are generated using a formula.

Examples

@@ -991,7 +991,7 @@

Elementary Sequences
-coeff_mul(coeff)[source]
+coeff_mul(coeff)[source]

See docstring of SeqBase.coeff_mul

@@ -999,7 +999,7 @@

Elementary Sequences
-class sympy.series.sequences.SeqPer(periodical, limits=None)[source]
+class sympy.series.sequences.SeqPer(periodical, limits=None)[source]

Represents a periodic sequence.

The elements are repeated after a given period.

Examples

@@ -1045,7 +1045,7 @@

Elementary Sequences
-coeff_mul(coeff)[source]
+coeff_mul(coeff)[source]

See docstring of SeqBase.coeff_mul

@@ -1056,7 +1056,7 @@

Elementary SequencesSingleton Sequences

-class sympy.series.sequences.EmptySequence[source]
+class sympy.series.sequences.EmptySequence[source]

Represents an empty sequence.

The empty sequence is also available as a singleton as S.EmptySequence.

@@ -1075,7 +1075,7 @@

Singleton Sequences
-coeff_mul(coeff)[source]
+coeff_mul(coeff)[source]

See docstring of SeqBase.coeff_mul

@@ -1086,7 +1086,7 @@

Singleton Sequences

-class sympy.series.sequences.SeqAdd(*args, **kwargs)[source]
+class sympy.series.sequences.SeqAdd(*args, **kwargs)[source]

Represents term-wise addition of sequences.

Rules:
-)[source] +)[source]

A finite degree recursive sequence.

Parameters:
diff --git a/dev/modules/series/series.html b/dev/modules/series/series.html index a3073060fb7..6c3e9177e3b 100644 --- a/dev/modules/series/series.html +++ b/dev/modules/series/series.html @@ -808,7 +808,7 @@

LimitsThe main purpose of this module is the computation of limits.

-sympy.series.limits.limit(e, z, z0, dir='+')[source]
+sympy.series.limits.limit(e, z, z0, dir='+')[source]

Computes the limit of e(z) at the point z0.

Parameters:
@@ -862,7 +862,7 @@

Limits
-class sympy.series.limits.Limit(e, z, z0, dir='+')[source]
+class sympy.series.limits.Limit(e, z, z0, dir='+')[source]

Represents an unevaluated limit.

Examples

>>> from sympy import Limit, sin
@@ -875,7 +875,7 @@ 

Limits
-doit(**hints)[source]
+doit(**hints)[source]

Evaluates the limit.

Parameters:
@@ -971,7 +971,7 @@

Notes

Reference

-sympy.series.gruntz.gruntz(e, z, z0, dir='+')[source]
+sympy.series.gruntz.gruntz(e, z, z0, dir='+')[source]

Compute the limit of e(z) at the point z0 using the Gruntz algorithm.

Explanation

z0 can be any expression, including oo and -oo.

@@ -985,13 +985,13 @@

Reference
-sympy.series.gruntz.compare(a, b, x)[source]
+sympy.series.gruntz.compare(a, b, x)[source]

Returns “<” if a<b, “=” for a == b, “>” for a>b

-sympy.series.gruntz.rewrite(e, Omega, x, wsym)[source]
+sympy.series.gruntz.rewrite(e, Omega, x, wsym)[source]

e(x) … the function Omega … the mrv set wsym … the symbol which is going to be used for w

@@ -1001,7 +1001,7 @@

Reference
-sympy.series.gruntz.build_expression_tree(Omega, rewrites)[source]
+sympy.series.gruntz.build_expression_tree(Omega, rewrites)[source]

Helper function for rewrite.

We need to sort Omega (mrv set) so that we replace an expression before we replace any expression in terms of which it has to be rewritten:

@@ -1017,26 +1017,26 @@

Reference
-sympy.series.gruntz.mrv_leadterm(e, x)[source]
+sympy.series.gruntz.mrv_leadterm(e, x)[source]

Returns (c0, e0) for e.

-sympy.series.gruntz.calculate_series(e, x, logx=None)[source]
+sympy.series.gruntz.calculate_series(e, x, logx=None)[source]

Calculates at least one term of the series of e in x.

This is a place that fails most often, so it is in its own function.

-sympy.series.gruntz.limitinf(e, x)[source]
+sympy.series.gruntz.limitinf(e, x)[source]

Limit e(x) for x-> oo.

-sympy.series.gruntz.sign(e, x)[source]
+sympy.series.gruntz.sign(e, x)[source]

Returns a sign of an expression e(x) for x->oo.

e >  0 for x sufficiently large ...  1
 e == 0 for x sufficiently large ...  0
@@ -1052,14 +1052,14 @@ 

Reference
-sympy.series.gruntz.mrv(e, x)[source]
+sympy.series.gruntz.mrv(e, x)[source]

Returns a SubsSet of most rapidly varying (mrv) subexpressions of ‘e’, and e rewritten in terms of these

-sympy.series.gruntz.mrv_max1(f, g, exps, x)[source]
+sympy.series.gruntz.mrv_max1(f, g, exps, x)[source]

Computes the maximum of two sets of expressions f and g, which are in the same comparability class, i.e. mrv_max1() compares (two elements of) f and g and returns the set, which is in the higher comparability class @@ -1069,7 +1069,7 @@

Reference
-sympy.series.gruntz.mrv_max3(f, expsf, g, expsg, union, expsboth, x)[source]
+sympy.series.gruntz.mrv_max3(f, expsf, g, expsg, union, expsboth, x)[source]

Computes the maximum of two sets of expressions f and g, which are in the same comparability class, i.e. max() compares (two elements of) f and g and returns either (f, expsf) [if f is larger], (g, expsg) @@ -1078,7 +1078,7 @@

Reference
-class sympy.series.gruntz.SubsSet[source]
+class sympy.series.gruntz.SubsSet[source]

Stores (expr, dummy) pairs, and how to rewrite expr-s.

Explanation

The gruntz algorithm needs to rewrite certain expressions in term of a new @@ -1122,25 +1122,25 @@

Reference
-copy()[source]
+copy()[source]

Create a shallow copy of SubsSet

-do_subs(e)[source]
+do_subs(e)[source]

Substitute the variables with expressions

-meets(s2)[source]
+meets(s2)[source]

Tell whether or not self and s2 have non-empty intersection

-union(s2, exps=None)[source]
+union(s2, exps=None)[source]

Compute the union of self and s2, adjusting exps

@@ -1167,7 +1167,7 @@

Examples

Reference

-sympy.series.series.series(expr, x=None, x0=0, n=6, dir='+')[source]
+sympy.series.series.series(expr, x=None, x0=0, n=6, dir='+')[source]

Series expansion of expr around point \(x = x0\).

Parameters:
@@ -1256,7 +1256,7 @@

ExamplesReference

-class sympy.series.order.Order(expr, *args, **kwargs)[source]
+class sympy.series.order.Order(expr, *args, **kwargs)[source]

Represents the limiting behavior of some function.

Explanation

The order of a function characterizes the function based on the limiting @@ -1364,7 +1364,7 @@

Reference
-contains(expr)[source]
+contains(expr)[source]

Return True if expr belongs to Order(self.expr, *self.variables). Return False if self belongs to expr. Return None if the inclusion relation cannot be determined @@ -1382,7 +1382,7 @@

Series Acceleration

-sympy.series.acceleration.richardson(A, k, n, N)[source]
+sympy.series.acceleration.richardson(A, k, n, N)[source]

Calculate an approximation for lim k->oo A(k) using Richardson extrapolation with the terms A(n), A(n+1), …, A(n+N+1). Choosing N ~= 2*n often gives good results.

@@ -1428,7 +1428,7 @@

Reference
-sympy.series.acceleration.shanks(A, k, n, m=1)[source]
+sympy.series.acceleration.shanks(A, k, n, m=1)[source]

Calculate an approximation for lim k->oo A(k) using the n-term Shanks transformation S(A)(n). With m > 1, calculate the m-fold recursive Shanks transformation S(S(…S(A)…))(n).

@@ -1458,7 +1458,7 @@

Residues

Reference

-sympy.series.residues.residue(expr, x, x0)[source]
+sympy.series.residues.residue(expr, x, x0)[source]

Finds the residue of expr at the point x=x0.

The residue is defined as the coefficient of 1/(x-x0) in the power series expansion about x=x0.

diff --git a/dev/modules/sets.html b/dev/modules/sets.html index da0e4b34aff..bb50a34ae37 100644 --- a/dev/modules/sets.html +++ b/dev/modules/sets.html @@ -807,7 +807,7 @@
Documentation Version

Basic Sets

-class sympy.sets.sets.Set(*args)[source]
+class sympy.sets.sets.Set(*args)[source]

The base class for any kind of set.

Explanation

This is not meant to be used directly as a container of items. It does not @@ -860,7 +860,7 @@

Documentation Version
-complement(universe)[source]
+complement(universe)[source]

The complement of ‘self’ w.r.t the given universe.

Examples

>>> from sympy import Interval, S
@@ -876,7 +876,7 @@ 
Documentation Version
-contains(other)[source]
+contains(other)[source]

Returns a SymPy value indicating whether other is contained in self: true if it is, false if it is not, else an unevaluated Contains expression (or, as in the case of @@ -943,7 +943,7 @@

Documentation Version
-intersect(other)[source]
+intersect(other)[source]

Returns the intersection of ‘self’ and ‘other’.

Examples

>>> from sympy import Interval
@@ -964,7 +964,7 @@ 
Documentation Version
-intersection(other)[source]
+intersection(other)[source]

Alias for intersect()

@@ -986,7 +986,7 @@
Documentation Version
-is_disjoint(other)[source]
+is_disjoint(other)[source]

Returns True if self and other are disjoint.

Examples

>>> from sympy import Interval
@@ -1026,7 +1026,7 @@ 
Documentation Version
-is_proper_subset(other)[source]
+is_proper_subset(other)[source]

Returns True if self is a proper subset of other.

Examples

>>> from sympy import Interval
@@ -1040,7 +1040,7 @@ 
Documentation Version
-is_proper_superset(other)[source]
+is_proper_superset(other)[source]

Returns True if self is a proper superset of other.

Examples

>>> from sympy import Interval
@@ -1054,7 +1054,7 @@ 
Documentation Version
-is_subset(other)[source]
+is_subset(other)[source]

Returns True if self is a subset of other.

Examples

>>> from sympy import Interval
@@ -1068,7 +1068,7 @@ 
Documentation Version
-is_superset(other)[source]
+is_superset(other)[source]

Returns True if self is a superset of other.

Examples

>>> from sympy import Interval
@@ -1082,19 +1082,19 @@ 
Documentation Version
-isdisjoint(other)[source]
+isdisjoint(other)[source]

Alias for is_disjoint()

-issubset(other)[source]
+issubset(other)[source]

Alias for is_subset()

-issuperset(other)[source]
+issuperset(other)[source]

Alias for is_superset()

@@ -1174,7 +1174,7 @@
Documentation Version
-powerset()[source]
+powerset()[source]

Find the Power set of self.

Examples

>>> from sympy import EmptySet, FiniteSet, Interval
@@ -1223,7 +1223,7 @@ 
Documentation Version
-symmetric_difference(other)[source]
+symmetric_difference(other)[source]

Returns symmetric difference of self and other.

Examples

>>> from sympy import Interval, S
@@ -1249,7 +1249,7 @@ 
Documentation Version
-union(other)[source]
+union(other)[source]

Returns the union of self and other.

Examples

As a shortcut it is possible to use the + operator:

@@ -1275,7 +1275,7 @@
Documentation Version
-sympy.sets.sets.imageset(*args)[source]
+sympy.sets.sets.imageset(*args)[source]

Return an image of the set under transformation f.

Explanation

If this function cannot compute the image, it returns an @@ -1335,7 +1335,7 @@

Elementary Setsright_open=False,

-)[source] +)[source]

Represents a real interval as a Set.

Usage:

Returns an interval with end points start and end.

@@ -1379,19 +1379,19 @@

Elementary Sets
-classmethod Lopen(a, b)[source]
+classmethod Lopen(a, b)[source]

Return an interval not including the left boundary.

-classmethod Ropen(a, b)[source]
+classmethod Ropen(a, b)[source]

Return an interval not including the right boundary.

-as_relational(x)[source]
+as_relational(x)[source]

Rewrite an interval in terms of inequalities and logic operators.

@@ -1436,7 +1436,7 @@

Elementary Sets
-classmethod open(a, b)[source]
+classmethod open(a, b)[source]

Return an interval including neither boundary.

@@ -1471,7 +1471,7 @@

Elementary Sets
-class sympy.sets.sets.FiniteSet(*args, **kwargs)[source]
+class sympy.sets.sets.FiniteSet(*args, **kwargs)[source]

Represents a finite set of Sympy expressions.

Examples

>>> from sympy import FiniteSet, Symbol, Interval, Naturals0
@@ -1502,7 +1502,7 @@ 

Elementary Sets
-as_relational(symbol)[source]
+as_relational(symbol)[source]

Rewrite a FiniteSet in terms of equalities and logic operators.

@@ -1513,7 +1513,7 @@

Elementary Sets

-class sympy.sets.sets.Union(*args, **kwargs)[source]
+class sympy.sets.sets.Union(*args, **kwargs)[source]

Represents a union of sets as a Set.

Examples

>>> from sympy import Union, Interval
@@ -1540,7 +1540,7 @@ 

Compound Sets
-as_relational(symbol)[source]
+as_relational(symbol)[source]

Rewrite a Union in terms of equalities and logic operators.

@@ -1548,7 +1548,7 @@

Compound Sets
-class sympy.sets.sets.Intersection(*args, evaluate=None)[source]
+class sympy.sets.sets.Intersection(*args, evaluate=None)[source]

Represents an intersection of sets as a Set.

Examples

>>> from sympy import Intersection, Interval
@@ -1574,7 +1574,7 @@ 

Compound Sets
-as_relational(symbol)[source]
+as_relational(symbol)[source]

Rewrite an Intersection in terms of equalities and logic operators

@@ -1582,7 +1582,7 @@

Compound Sets
-class sympy.sets.sets.ProductSet(*sets, **assumptions)[source]
+class sympy.sets.sets.ProductSet(*sets, **assumptions)[source]

Represents a Cartesian Product of Sets.

Explanation

Returns a Cartesian product given several sets as either an iterable @@ -1647,7 +1647,7 @@

Compound Sets
-class sympy.sets.sets.Complement(a, b, evaluate=True)[source]
+class sympy.sets.sets.Complement(a, b, evaluate=True)[source]

Represents the set difference or relative complement of a set with another set.

@@ -1674,14 +1674,14 @@

Compound Sets
-as_relational(symbol)[source]
+as_relational(symbol)[source]

Rewrite a complement in terms of equalities and logic operators

-static reduce(A, B)[source]
+static reduce(A, B)[source]

Simplify a Complement.

@@ -1689,7 +1689,7 @@

Compound Sets
-class sympy.sets.sets.SymmetricDifference(a, b, evaluate=True)[source]
+class sympy.sets.sets.SymmetricDifference(a, b, evaluate=True)[source]

Represents the set of elements which are in either of the sets and not in their intersection.

Examples

@@ -1711,7 +1711,7 @@

Compound Sets
-as_relational(symbol)[source]
+as_relational(symbol)[source]

Rewrite a symmetric_difference in terms of equalities and logic operators

@@ -1720,7 +1720,7 @@

Compound Sets
-class sympy.sets.sets.DisjointUnion(*sets)[source]
+class sympy.sets.sets.DisjointUnion(*sets)[source]

Represents the disjoint union (also known as the external disjoint union) of a finite number of sets.

Examples

@@ -1747,7 +1747,7 @@

Compound Sets

-class sympy.sets.sets.EmptySet[source]
+class sympy.sets.sets.EmptySet[source]

Represents the empty set. The empty set is available as a singleton as S.EmptySet.

Examples

@@ -1775,7 +1775,7 @@

Singleton Sets
-class sympy.sets.sets.UniversalSet[source]
+class sympy.sets.sets.UniversalSet[source]

Represents the set of all things. The universal set is available as a singleton as S.UniversalSet.

Examples

@@ -1806,7 +1806,7 @@

Singleton Sets

Special Sets

-class sympy.sets.fancysets.Rationals[source]
+class sympy.sets.fancysets.Rationals[source]

Represents the rational numbers. This set is also available as the singleton S.Rationals.

Examples

@@ -1822,7 +1822,7 @@

Singleton Sets
-class sympy.sets.fancysets.Naturals[source]
+class sympy.sets.fancysets.Naturals[source]

Represents the natural numbers (or counting numbers) which are all positive integers starting from 1. This set is also available as the singleton S.Naturals.

@@ -1854,7 +1854,7 @@

Singleton Sets
-class sympy.sets.fancysets.Naturals0[source]
+class sympy.sets.fancysets.Naturals0[source]

Represents the whole numbers which are all the non-negative integers, inclusive of zero.

@@ -1870,7 +1870,7 @@

Singleton Sets
-class sympy.sets.fancysets.Integers[source]
+class sympy.sets.fancysets.Integers[source]

Represents all integers: positive, negative and zero. This set is also available as the singleton S.Integers.

Examples

@@ -1905,7 +1905,7 @@

Singleton Sets
-class sympy.sets.fancysets.Reals[source]
+class sympy.sets.fancysets.Reals[source]

Represents all real numbers from negative infinity to positive infinity, including all integer, rational and irrational numbers. @@ -1932,7 +1932,7 @@

Singleton Sets
-class sympy.sets.fancysets.Complexes[source]
+class sympy.sets.fancysets.Complexes[source]

The Set of all complex numbers

Examples

>>> from sympy import S, I
@@ -1950,7 +1950,7 @@ 

Singleton Sets
-class sympy.sets.fancysets.ImageSet(flambda, *sets)[source]
+class sympy.sets.fancysets.ImageSet(flambda, *sets)[source]

Image of a set under a mathematical function. The transformation must be given as a Lambda function which has as many arguments as the elements of the set upon which it operates, e.g. 1 argument @@ -2008,7 +2008,7 @@

Singleton Sets
-class sympy.sets.fancysets.Range(*args)[source]
+class sympy.sets.fancysets.Range(*args)[source]

Represents a range of integers. Can be called as Range(stop), Range(start, stop), or Range(start, stop, step); when step is not given it defaults to 1.

@@ -2090,7 +2090,7 @@

Singleton Sets
-as_relational(x)[source]
+as_relational(x)[source]

Rewrite a Range in terms of equalities and logic operators.

@@ -2110,7 +2110,7 @@

Singleton Sets
-class sympy.sets.fancysets.ComplexRegion(sets, polar=False)[source]
+class sympy.sets.fancysets.ComplexRegion(sets, polar=False)[source]

Represents the Set of all Complex Numbers. It can represent a region of Complex Plane in both the standard forms Polar and Rectangular coordinates.

@@ -2238,7 +2238,7 @@

Singleton Sets
-classmethod from_real(sets)[source]
+classmethod from_real(sets)[source]

Converts given subset of real numbers to a complex region.

Examples

>>> from sympy import Interval, ComplexRegion
@@ -2291,7 +2291,7 @@ 

Singleton Sets
-class sympy.sets.fancysets.CartesianComplexRegion(sets)[source]
+class sympy.sets.fancysets.CartesianComplexRegion(sets)[source]

Set representing a square region of the complex plane.

@@ -2314,7 +2314,7 @@

Singleton Sets
-class sympy.sets.fancysets.PolarComplexRegion(sets)[source]
+class sympy.sets.fancysets.PolarComplexRegion(sets)[source]

Set representing a polar region of the complex plane.

@@ -2339,7 +2339,7 @@

Singleton Sets
-sympy.sets.fancysets.normalize_theta_set(theta)[source]
+sympy.sets.fancysets.normalize_theta_set(theta)[source]

Normalize a Real Set \(theta\) in the interval \([0, 2\pi)\). It returns a normalized value of theta in the Set. For Interval, a maximum of one cycle \([0, 2\pi]\), is returned i.e. for theta equal to \([0, 10\pi]\), @@ -2386,7 +2386,7 @@

Singleton Sets

Power sets

-class sympy.sets.powerset.PowerSet(arg, evaluate=None)[source]
+class sympy.sets.powerset.PowerSet(arg, evaluate=None)[source]

A symbolic object representing a power set.

Parameters:
@@ -2460,7 +2460,7 @@

Singleton Setsbase_set=UniversalSet,

-)[source] +)[source]

Set of elements which satisfies a given condition.

@@ -2530,7 +2530,7 @@

Singleton Sets
-class sympy.sets.conditionset.Contains(x, s, evaluate=None)[source]
+class sympy.sets.conditionset.Contains(x, s, evaluate=None)[source]

Asserts that x is an element of the set S.

Examples

>>> from sympy import Symbol, Integer, S, Contains
@@ -2557,7 +2557,7 @@ 

Singleton Sets

-class sympy.sets.conditionset.SetKind(element_kind=None)[source]
+class sympy.sets.conditionset.SetKind(element_kind=None)[source]

SetKind is kind for all Sets

Every instance of Set will have kind SetKind parametrised by the kind of the elements of the Set. The kind of the elements might be diff --git a/dev/modules/simplify/fu.html b/dev/modules/simplify/fu.html index da013fb9dcb..94139b612e3 100644 --- a/dev/modules/simplify/fu.html +++ b/dev/modules/simplify/fu.html @@ -972,14 +972,14 @@

Documentation Version

Rules

-sympy.simplify.fu.TR0(rv)[source]
+sympy.simplify.fu.TR0(rv)[source]

Simplification of rational polynomials, trying to simplify the expression, e.g. combine things like 3*x + 2*x, etc….

-sympy.simplify.fu.TR1(rv)[source]
+sympy.simplify.fu.TR1(rv)[source]

Replace sec, csc with 1/cos, 1/sin

Examples

>>> from sympy.simplify.fu import TR1, sec, csc
@@ -992,7 +992,7 @@ 

Rules
-sympy.simplify.fu.TR2(rv)[source]
+sympy.simplify.fu.TR2(rv)[source]

Replace tan and cot with sin/cos and cos/sin

Examples

>>> from sympy.simplify.fu import TR2
@@ -1010,7 +1010,7 @@ 

Rules
-sympy.simplify.fu.TR2i(rv, half=False)[source]
+sympy.simplify.fu.TR2i(rv, half=False)[source]
Converts ratios involving sin and cos as follows::

sin(x)/cos(x) -> tan(x) sin(x)/(cos(x) + 1) -> tan(x/2) if half=True

@@ -1040,7 +1040,7 @@

Rules
-sympy.simplify.fu.TR3(rv)[source]
+sympy.simplify.fu.TR3(rv)[source]

Induced formula: example sin(-a) = -sin(a)

Examples

>>> from sympy.simplify.fu import TR3
@@ -1059,7 +1059,7 @@ 

Rules
-sympy.simplify.fu.TR4(rv)[source]
+sympy.simplify.fu.TR4(rv)[source]

Identify values of special angles.

A= 0 Pi/6 Pi/4 Pi/3 Pi/2

sin(a) 0 1/2 sqrt(2)/2 sqrt(3)/2 1 @@ -1082,7 +1082,7 @@

Rules
-sympy.simplify.fu.TR5(rv, max=4, pow=False)[source]
+sympy.simplify.fu.TR5(rv, max=4, pow=False)[source]

Replacement of sin**2 with 1 - cos(x)**2.

See _TR56 docstring for advanced use of max and pow.

Examples

@@ -1101,7 +1101,7 @@

Rules
-sympy.simplify.fu.TR6(rv, max=4, pow=False)[source]
+sympy.simplify.fu.TR6(rv, max=4, pow=False)[source]

Replacement of cos**2 with 1 - sin(x)**2.

See _TR56 docstring for advanced use of max and pow.

Examples

@@ -1120,7 +1120,7 @@

Rules
-sympy.simplify.fu.TR7(rv)[source]
+sympy.simplify.fu.TR7(rv)[source]

Lowering the degree of cos(x)**2.

Examples

>>> from sympy.simplify.fu import TR7
@@ -1136,7 +1136,7 @@ 

Rules
-sympy.simplify.fu.TR8(rv, first=True)[source]
+sympy.simplify.fu.TR8(rv, first=True)[source]

Converting products of cos and/or sin to a sum or difference of cos and or sin terms.

Examples

@@ -1154,7 +1154,7 @@

Rules
-sympy.simplify.fu.TR9(rv)[source]
+sympy.simplify.fu.TR9(rv)[source]

Sum of cos or sin terms as a product of cos or sin.

Examples

>>> from sympy.simplify.fu import TR9
@@ -1177,7 +1177,7 @@ 

Rules
-sympy.simplify.fu.TR10(rv, first=True)[source]
+sympy.simplify.fu.TR10(rv, first=True)[source]

Separate sums in cos and sin.

Examples

>>> from sympy.simplify.fu import TR10
@@ -1195,7 +1195,7 @@ 

Rules
-sympy.simplify.fu.TR10i(rv)[source]
+sympy.simplify.fu.TR10i(rv)[source]

Sum of products to function of sum.

Examples

>>> from sympy.simplify.fu import TR10i
@@ -1215,7 +1215,7 @@ 

Rules
-sympy.simplify.fu.TR11(rv, base=None)[source]
+sympy.simplify.fu.TR11(rv, base=None)[source]

Function of double angle to product. The base argument can be used to indicate what is the un-doubled argument, e.g. if 3*pi/7 is the base then cosine and sine functions with argument 6*pi/7 will be replaced.

@@ -1257,7 +1257,7 @@

Rules
-sympy.simplify.fu.TR12(rv, first=True)[source]
+sympy.simplify.fu.TR12(rv, first=True)[source]

Separate sums in tan.

Examples

>>> from sympy.abc import x, y
@@ -1271,7 +1271,7 @@ 

Rules
-sympy.simplify.fu.TR12i(rv)[source]
+sympy.simplify.fu.TR12i(rv)[source]

Combine tan arguments as (tan(y) + tan(x))/(tan(x)*tan(y) - 1) -> -tan(x + y).

Examples

@@ -1294,7 +1294,7 @@

Rules
-sympy.simplify.fu.TR13(rv)[source]
+sympy.simplify.fu.TR13(rv)[source]

Change products of tan or cot.

Examples

>>> from sympy.simplify.fu import TR13
@@ -1309,7 +1309,7 @@ 

Rules
-sympy.simplify.fu.TRmorrie(rv)[source]
+sympy.simplify.fu.TRmorrie(rv)[source]

Returns cos(x)*cos(2*x)*…*cos(2**(k-1)*x) -> sin(2**k*x)/(2**k*sin(x))

Examples

>>> from sympy.simplify.fu import TRmorrie, TR8, TR3
@@ -1370,7 +1370,7 @@ 

Rules
-sympy.simplify.fu.TR14(rv, first=True)[source]
+sympy.simplify.fu.TR14(rv, first=True)[source]

Convert factored powers of sin and cos identities into simpler expressions.

Examples

@@ -1392,7 +1392,7 @@

Rules
-sympy.simplify.fu.TR15(rv, max=4, pow=False)[source]
+sympy.simplify.fu.TR15(rv, max=4, pow=False)[source]

Convert sin(x)**-2 to 1 + cot(x)**2.

See _TR56 docstring for advanced use of max and pow.

Examples

@@ -1407,7 +1407,7 @@

Rules
-sympy.simplify.fu.TR16(rv, max=4, pow=False)[source]
+sympy.simplify.fu.TR16(rv, max=4, pow=False)[source]

Convert cos(x)**-2 to 1 + tan(x)**2.

See _TR56 docstring for advanced use of max and pow.

Examples

@@ -1422,7 +1422,7 @@

Rules
-sympy.simplify.fu.TR111(rv)[source]
+sympy.simplify.fu.TR111(rv)[source]

Convert f(x)**-i to g(x)**i where either i is an integer or the base is positive and f, g are: tan, cot; sin, csc; or cos, sec.

Examples

@@ -1437,7 +1437,7 @@

Rules
-sympy.simplify.fu.TR22(rv, max=4, pow=False)[source]
+sympy.simplify.fu.TR22(rv, max=4, pow=False)[source]

Convert tan(x)**2 to sec(x)**2 - 1 and cot(x)**2 to csc(x)**2 - 1.

See _TR56 docstring for advanced use of max and pow.

Examples

@@ -1454,7 +1454,7 @@

Rules
-sympy.simplify.fu.TRpower(rv)[source]
+sympy.simplify.fu.TRpower(rv)[source]

Convert sin(x)**n and cos(x)**n with positive n to sums.

Examples

>>> from sympy.simplify.fu import TRpower
@@ -1477,7 +1477,7 @@ 

Rules
-sympy.simplify.fu.fu(rv, measure=<function <lambda>>)[source]
+sympy.simplify.fu.fu(rv, measure=<function <lambda>>)[source]

Attempt to simplify expression by using transformation rules given in the algorithm by Fu et al.

fu() will try to minimize the objective function measure. diff --git a/dev/modules/simplify/simplify.html b/dev/modules/simplify/simplify.html index 1094cfd9b80..bbd8d72f7b5 100644 --- a/dev/modules/simplify/simplify.html +++ b/dev/modules/simplify/simplify.html @@ -817,7 +817,7 @@

Documentation Version
**kwargs,
-)[source] +)[source]

Simplifies the given expression.

Explanation

Simplification is not a well defined term and the exact strategies @@ -974,7 +974,7 @@

Documentation Version
force=False,

-)[source] +)[source]

Separates variables in an expression, if possible. By default, it separates with respect to all symbols in an expression and collects constant coefficients that are @@ -1034,7 +1034,7 @@

Documentation Version
-sympy.simplify.simplify.nthroot(expr, n, max_len=4, prec=15)[source]
+sympy.simplify.simplify.nthroot(expr, n, max_len=4, prec=15)[source]

Compute a real nth-root of a sum of surds.

Parameters:
@@ -1058,7 +1058,7 @@
Documentation Version
-sympy.simplify.simplify.kroneckersimp(expr)[source]
+sympy.simplify.simplify.kroneckersimp(expr)[source]

Simplify expressions with KroneckerDelta.

The only simplification currently attempted is to identify multiplicative cancellation:

Examples

@@ -1072,7 +1072,7 @@
Documentation Version
-sympy.simplify.simplify.besselsimp(expr)[source]
+sympy.simplify.simplify.besselsimp(expr)[source]

Simplify bessel-type functions.

Explanation

This routine tries to simplify bessel-type functions. Currently it only @@ -1099,7 +1099,7 @@

Documentation Version
-sympy.simplify.simplify.hypersimp(f, k)[source]
+sympy.simplify.simplify.hypersimp(f, k)[source]

Given combinatorial term f(k) simplify its consecutive term ratio i.e. f(k+1)/f(k). The input term can be composed of functions and integer sequences which have equivalent representation in terms @@ -1127,7 +1127,7 @@

Documentation Version
-sympy.simplify.simplify.hypersimilar(f, g, k)[source]
+sympy.simplify.simplify.hypersimilar(f, g, k)[source]

Returns True if f and g are hyper-similar.

Explanation

Similarity in hypergeometric sense means that a quotient of @@ -1149,7 +1149,7 @@

Documentation Version
rational_conversion='base10',
-)[source] +)[source]

Find a simple representation for a number or, if there are free symbols or if rational=True, then replace Floats with their Rational equivalents. If no change is made and rational is not False then Floats will at least be @@ -1195,7 +1195,7 @@

Documentation Version
-sympy.simplify.simplify.posify(eq)[source]
+sympy.simplify.simplify.posify(eq)[source]

Return eq (with generic symbols made positive) and a dictionary containing the mapping between the old and new symbols.

@@ -1237,7 +1237,7 @@
Documentation Version
-sympy.simplify.simplify.logcombine(expr, force=False)[source]
+sympy.simplify.simplify.logcombine(expr, force=False)[source]

Takes logarithms and combines them using the following rules:

  • log(x) + log(y) == log(x*y) if both are positive

  • @@ -1284,7 +1284,7 @@
    Documentation Version
    -sympy.simplify.radsimp.radsimp(expr, symbolic=True, max_terms=4)[source]
    +sympy.simplify.radsimp.radsimp(expr, symbolic=True, max_terms=4)[source]

    Rationalize the denominator by removing square roots.

    Explanation

    The expression returned from radsimp must be used with caution @@ -1358,7 +1358,7 @@

    Documentation Version
    -sympy.simplify.radsimp.rad_rationalize(num, den)[source]
    +sympy.simplify.radsimp.rad_rationalize(num, den)[source]

    Rationalize num/den by removing square roots in the denominator; num and den are sum of terms whose squares are positive rationals.

    Examples

    @@ -1383,7 +1383,7 @@
    Documentation Version
    distribute_order_term=True,
    -)[source] +)[source]

    Collect additive terms of an expression.

    Explanation

    This function collects additive terms of an expression with respect @@ -1530,7 +1530,7 @@

    Documentation Version
    -sympy.simplify.radsimp.rcollect(expr, *vars)[source]
    +sympy.simplify.radsimp.rcollect(expr, *vars)[source]

    Recursively collect sums in an expression.

    Examples

    >>> from sympy.simplify import rcollect
    @@ -1552,7 +1552,7 @@ 
    Documentation Version
    -sympy.simplify.radsimp.collect_sqrt(expr, evaluate=None)[source]
    +sympy.simplify.radsimp.collect_sqrt(expr, evaluate=None)[source]

    Return expr with terms having common square roots collected together. If evaluate is False a count indicating the number of sqrt-containing terms will be returned and, if non-zero, the terms of the Add will be @@ -1594,7 +1594,7 @@

    Documentation Version
    -sympy.simplify.radsimp.collect_const(expr, *vars, Numbers=True)[source]
    +sympy.simplify.radsimp.collect_const(expr, *vars, Numbers=True)[source]

    A non-greedy collection of terms with similar number coefficients in an Add expr. If vars is given then only those constants will be targeted. Although any Number can also be targeted, if this is not @@ -1661,7 +1661,7 @@

    Documentation Version
    -sympy.simplify.radsimp.fraction(expr, exact=False)[source]
    +sympy.simplify.radsimp.fraction(expr, exact=False)[source]

    Returns a pair with expression’s numerator and denominator. If the given expression is not a fraction then this function will return the tuple (expr, 1).

    @@ -1724,7 +1724,7 @@
    Documentation Version
    -sympy.simplify.ratsimp.ratsimp(expr)[source]
    +sympy.simplify.ratsimp.ratsimp(expr)[source]

    Put an expression over a common denominator, cancel and reduce.

    Examples

    >>> from sympy import ratsimp
    @@ -1748,7 +1748,7 @@ 
    Documentation Version
    **args,
    -)[source] +)[source]

    Simplifies a rational expression expr modulo the prime ideal generated by G. G should be a Groebner basis of the ideal.

    @@ -1779,7 +1779,7 @@
    Documentation Version
    -sympy.simplify.trigsimp.trigsimp(expr, inverse=False, **opts)[source]
    +sympy.simplify.trigsimp.trigsimp(expr, inverse=False, **opts)[source]

    Returns a reduced expression by using known trig identities.

    Parameters:
    @@ -1857,7 +1857,7 @@
    Documentation Version
    measure=<function count_ops>,
    -)[source] +)[source]

    Reduce expression by combining powers with similar bases and exponents.

    Explanation

    If deep is True then powsimp() will also simplify arguments of @@ -1937,7 +1937,7 @@

    Documentation Version
    -sympy.simplify.powsimp.powdenest(eq, force=False, polar=False)[source]
    +sympy.simplify.powsimp.powdenest(eq, force=False, polar=False)[source]

    Collect exponents on powers as assumptions allow.

    Explanation

    @@ -2031,7 +2031,7 @@
    Documentation Version
    -sympy.simplify.combsimp.combsimp(expr)[source]
    +sympy.simplify.combsimp.combsimp(expr)[source]

    Simplify combinatorial expressions.

    Explanation

    This function takes as input an expression containing factorials, @@ -2063,7 +2063,7 @@

    Documentation Version
    -sympy.simplify.sqrtdenest.sqrtdenest(expr, max_iter=3)[source]
    +sympy.simplify.sqrtdenest.sqrtdenest(expr, max_iter=3)[source]

    Denests sqrts in an expression that contain other square roots if possible, otherwise returns the expr unchanged. This is based on the algorithms of [1].

    @@ -2106,7 +2106,7 @@
    Documentation Version
    list=True,
    -)[source] +)[source]

    Perform common subexpression elimination on an expression.

    Parameters:
    @@ -2202,7 +2202,7 @@
    Documentation Version
    -sympy.simplify.cse_main.opt_cse(exprs, order='canonical')[source]
    +sympy.simplify.cse_main.opt_cse(exprs, order='canonical')[source]

    Find optimization opportunities in Adds, Muls, Pows and negative coefficient Muls.

    @@ -2247,7 +2247,7 @@
    Documentation Version
    ignore=(),
    -)[source] +)[source]

    Perform raw CSE on expression tree, taking opt_subs into account.

    Parameters:
    @@ -2288,7 +2288,7 @@
    Documentation Version
    place=None,
    -)[source] +)[source]

    Expand hypergeometric functions. If allow_hyper is True, allow partial simplification (that is a result different from input, but still containing hypergeometric functions).

    @@ -2313,7 +2313,7 @@
    Documentation Version
    -class sympy.simplify.epathtools.EPath(path)[source]
    +class sympy.simplify.epathtools.EPath(path)[source]

    Manipulate expressions using paths.

    EPath grammar in EBNF notation:

    literal   ::= /[A-Za-z_][A-Za-z_0-9]*/
    @@ -2331,7 +2331,7 @@ 
    Documentation Version

    See the docstring of the epath() function.

    -apply(expr, func, args=None, kwargs=None)[source]
    +apply(expr, func, args=None, kwargs=None)[source]

    Modify parts of an expression selected by a path.

    Examples

    >>> from sympy.simplify.epathtools import EPath
    @@ -2359,7 +2359,7 @@ 
    Documentation Version
    -select(expr)[source]
    +select(expr)[source]

    Retrieve parts of an expression selected by a path.

    Examples

    >>> from sympy.simplify.epathtools import EPath
    @@ -2399,7 +2399,7 @@ 
    Documentation Version
    kwargs=None,
    -)[source] +)[source]

    Manipulate parts of an expression selected by a path.

    Parameters:
    diff --git a/dev/modules/solvers/diophantine.html b/dev/modules/solvers/diophantine.html index 30bd0634005..4cc7be60083 100644 --- a/dev/modules/solvers/diophantine.html +++ b/dev/modules/solvers/diophantine.html @@ -1135,7 +1135,7 @@

    User Functionsfrom sympy import *:

    -sympy.solvers.diophantine.diophantine.diophantine(eq, param=t, syms=None, permute=False)[source]
    +sympy.solvers.diophantine.diophantine.diophantine(eq, param=t, syms=None, permute=False)[source]

    Simplify the solution procedure of diophantine equation eq by converting it into a product of terms which should equal zero.

    Explanation

    @@ -1193,7 +1193,7 @@

    User Functionsfrom sympy.solvers.diophantine import *:

    -sympy.solvers.diophantine.diophantine.classify_diop(eq, _dict=True)[source]
    +sympy.solvers.diophantine.diophantine.classify_diop(eq, _dict=True)[source]
    @@ -1202,7 +1202,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_solve(eq, param=t)[source]
    +sympy.solvers.diophantine.diophantine.diop_solve(eq, param=t)[source]

    Solves the diophantine equation eq.

    Explanation

    Unlike diophantine(), factoring of eq is not attempted. Uses @@ -1239,7 +1239,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_linear(eq, param=t)[source]
    +sympy.solvers.diophantine.diophantine.diop_linear(eq, param=t)[source]

    Solves linear diophantine equations.

    A linear diophantine equation is an equation of the form \(a_{1}x_{1} + a_{2}x_{2} + .. + a_{n}x_{n} = 0\) where \(a_{1}, a_{2}, ..a_{n}\) are @@ -1271,7 +1271,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.base_solution_linear(c, a, b, t=None)[source]
    +sympy.solvers.diophantine.diophantine.base_solution_linear(c, a, b, t=None)[source]

    Return the base solution for the linear equation, \(ax + by = c\).

    Explanation

    Used by diop_linear() to find the base solution of a linear @@ -1297,7 +1297,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_quadratic(eq, param=t)[source]
    +sympy.solvers.diophantine.diophantine.diop_quadratic(eq, param=t)[source]

    Solves quadratic diophantine equations.

    i.e. equations of the form \(Ax^2 + Bxy + Cy^2 + Dx + Ey + F = 0\). Returns a set containing the tuples \((x, y)\) which contains the solutions. If there @@ -1337,7 +1337,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_DN(D, N, t=t)[source]
    +sympy.solvers.diophantine.diophantine.diop_DN(D, N, t=t)[source]

    Solves the equation \(x^2 - Dy^2 = N\).

    Explanation

    Mainly concerned with the case \(D > 0, D\) is not a perfect square, @@ -1392,7 +1392,7 @@

    Internal Functionsm: int,

    -) set[tuple[int, int]][source] +) set[tuple[int, int]][source]

    Solves \(ax^2 + by^2 = m\) where \(\gcd(a, b) = 1 = gcd(a, m)\) and \(a, b > 0\).

    Explanation

    Uses the algorithm due to Cornacchia. The method only finds primitive @@ -1431,7 +1431,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_bf_DN(D, N, t=t)[source]
    +sympy.solvers.diophantine.diophantine.diop_bf_DN(D, N, t=t)[source]

    Uses brute force to solve the equation, \(x^2 - Dy^2 = N\).

    Explanation

    Mainly concerned with the generalized Pell equation which is the case when @@ -1470,7 +1470,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.transformation_to_DN(eq)[source]
    +sympy.solvers.diophantine.diophantine.transformation_to_DN(eq)[source]

    This function transforms general quadratic, \(ax^2 + bxy + cy^2 + dx + ey + f = 0\) to more easy to deal with \(X^2 - DY^2 = N\) form.

    @@ -1542,7 +1542,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.transformation_to_normal(eq)[source]
    +sympy.solvers.diophantine.diophantine.transformation_to_normal(eq)[source]

    Returns the transformation Matrix that converts a general ternary quadratic equation eq (\(ax^2 + by^2 + cz^2 + dxy + eyz + fxz\)) to a form without cross terms: \(ax^2 + by^2 + cz^2 = 0\). This is @@ -1552,7 +1552,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.find_DN(eq)[source]
    +sympy.solvers.diophantine.diophantine.find_DN(eq)[source]

    This function returns a tuple, \((D, N)\) of the simplified form, \(x^2 - Dy^2 = N\), corresponding to the general quadratic, \(ax^2 + bxy + cy^2 + dx + ey + f = 0\).

    @@ -1588,7 +1588,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_ternary_quadratic(eq, parameterize=False)[source]
    +sympy.solvers.diophantine.diophantine.diop_ternary_quadratic(eq, parameterize=False)[source]

    Solves the general quadratic ternary form, \(ax^2 + by^2 + cz^2 + fxy + gyz + hxz = 0\).

    Returns a tuple \((x, y, z)\) which is a base solution for the above @@ -1616,7 +1616,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.square_factor(a)[source]
    +sympy.solvers.diophantine.diophantine.square_factor(a)[source]

    Returns an integer \(c\) s.t. \(a = c^2k, \ c,k \in Z\). Here \(k\) is square free. \(a\) can be given as an integer or a dictionary of factors.

    Examples

    @@ -1639,7 +1639,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.descent(A, B)[source]
    +sympy.solvers.diophantine.diophantine.descent(A, B)[source]

    Returns a non-trivial solution, (x, y, z), to \(x^2 = Ay^2 + Bz^2\) using Lagrange’s descent method with lattice-reduction. \(A\) and \(B\) are assumed to be valid for such a solution to exist.

    @@ -1669,7 +1669,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_general_pythagorean(eq, param=m)[source]
    +sympy.solvers.diophantine.diophantine.diop_general_pythagorean(eq, param=m)[source]

    Solves the general pythagorean equation, \(a_{1}^2x_{1}^2 + a_{2}^2x_{2}^2 + . . . + a_{n}^2x_{n}^2 - a_{n + 1}^2x_{n + 1}^2 = 0\).

    Returns a tuple which contains a parametrized solution to the equation, @@ -1691,7 +1691,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_general_sum_of_squares(eq, limit=1)[source]
    +sympy.solvers.diophantine.diophantine.diop_general_sum_of_squares(eq, limit=1)[source]

    Solves the equation \(x_{1}^2 + x_{2}^2 + . . . + x_{n}^2 - k = 0\).

    Returns at most limit number of solutions.

    Usage

    @@ -1721,7 +1721,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.diop_general_sum_of_even_powers(eq, limit=1)[source]
    +sympy.solvers.diophantine.diophantine.diop_general_sum_of_even_powers(eq, limit=1)[source]

    Solves the equation \(x_{1}^e + x_{2}^e + . . . + x_{n}^e - k = 0\) where \(e\) is an even, integer power.

    Returns at most limit number of solutions.

    @@ -1744,7 +1744,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.power_representation(n, p, k, zeros=False)[source]
    +sympy.solvers.diophantine.diophantine.power_representation(n, p, k, zeros=False)[source]

    Returns a generator for finding k-tuples of integers, \((n_{1}, n_{2}, . . . n_{k})\), such that \(n = n_{1}^p + n_{2}^p + . . . n_{k}^p\).

    @@ -1788,7 +1788,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.partition(n, k=None, zeros=False)[source]
    +sympy.solvers.diophantine.diophantine.partition(n, k=None, zeros=False)[source]

    Returns a generator that can be used to generate partitions of an integer \(n\).

    Explanation

    @@ -1827,7 +1827,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.sum_of_three_squares(n)[source]
    +sympy.solvers.diophantine.diophantine.sum_of_three_squares(n)[source]

    Returns a 3-tuple \((a, b, c)\) such that \(a^2 + b^2 + c^2 = n\) and \(a, b, c \geq 0\).

    Returns None if \(n = 4^a(8m + 7)\) for some \(a, m \in \mathbb{Z}\). See @@ -1878,7 +1878,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.sum_of_four_squares(n)[source]
    +sympy.solvers.diophantine.diophantine.sum_of_four_squares(n)[source]

    Returns a 4-tuple \((a, b, c, d)\) such that \(a^2 + b^2 + c^2 + d^2 = n\). Here \(a, b, c, d \geq 0\).

    @@ -1928,7 +1928,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.sum_of_powers(n, p, k, zeros=False)[source]
    +sympy.solvers.diophantine.diophantine.sum_of_powers(n, p, k, zeros=False)[source]

    Returns a generator for finding k-tuples of integers, \((n_{1}, n_{2}, . . . n_{k})\), such that \(n = n_{1}^p + n_{2}^p + . . . n_{k}^p\).

    @@ -1972,7 +1972,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.sum_of_squares(n, k, zeros=False)[source]
    +sympy.solvers.diophantine.diophantine.sum_of_squares(n, k, zeros=False)[source]

    Return a generator that yields the k-tuples of nonnegative values, the squares of which sum to n. If zeros is False (default) then the solution will not contain zeros. The nonnegative @@ -2015,7 +2015,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.merge_solution(var, var_t, solution)[source]
    +sympy.solvers.diophantine.diophantine.merge_solution(var, var_t, solution)[source]

    This is used to construct the full solution from the solutions of sub equations.

    Explanation

    @@ -2029,13 +2029,13 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.divisible(a, b)[source]
    +sympy.solvers.diophantine.diophantine.divisible(a, b)[source]

    Returns \(True\) if a is divisible by b and \(False\) otherwise.

    -sympy.solvers.diophantine.diophantine.PQa(P_0, Q_0, D)[source]
    +sympy.solvers.diophantine.diophantine.PQa(P_0, Q_0, D)[source]

    Returns useful information needed to solve the Pell equation.

    Explanation

    There are six sequences of integers defined related to the continued @@ -2070,7 +2070,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.equivalent(u, v, r, s, D, N)[source]
    +sympy.solvers.diophantine.diophantine.equivalent(u, v, r, s, D, N)[source]

    Returns True if two solutions \((u, v)\) and \((r, s)\) of \(x^2 - Dy^2 = N\) belongs to the same equivalence class and False otherwise.

    Explanation

    @@ -2103,7 +2103,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.parametrize_ternary_quadratic(eq)[source]
    +sympy.solvers.diophantine.diophantine.parametrize_ternary_quadratic(eq)[source]

    Returns the parametrized general solution for the ternary quadratic equation eq which has the form \(ax^2 + by^2 + cz^2 + fxy + gyz + hxz = 0\).

    @@ -2164,7 +2164,7 @@

    Internal Functionsparameterize=False,

    -)[source] +)[source]

    Solves the quadratic ternary diophantine equation, \(ax^2 + by^2 + cz^2 = 0\).

    Explanation

    @@ -2190,7 +2190,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.ldescent(A, B)[source]
    +sympy.solvers.diophantine.diophantine.ldescent(A, B)[source]

    Return a non-trivial solution to \(w^2 = Ax^2 + By^2\) using Lagrange’s method; return None if there is no such solution.

    @@ -2246,7 +2246,7 @@

    Internal Functionsb: int,

    -) tuple[int, int][source] +) tuple[int, int][source]

    Returns a reduced solution \((x, z)\) to the congruence \(X^2 - aZ^2 \equiv 0 \pmod{b}\) so that \(x^2 + |a|z^2\) is as small as possible. Here w is a solution of the congruence \(x^2 \equiv a \pmod{b}\).

    @@ -2321,7 +2321,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.holzer(x, y, z, a, b, c)[source]
    +sympy.solvers.diophantine.diophantine.holzer(x, y, z, a, b, c)[source]

    Simplify the solution \((x, y, z)\) of the equation \(ax^2 + by^2 = cz^2\) with \(a, b, c > 0\) and \(z^2 \geq \mid ab \mid\) to a new reduced solution \((x', y', z')\) such that \(z'^2 \leq \mid ab \mid\).

    @@ -2347,7 +2347,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.prime_as_sum_of_two_squares(p)[source]
    +sympy.solvers.diophantine.diophantine.prime_as_sum_of_two_squares(p)[source]

    Represent a prime \(p\) as a unique sum of two squares; this can only be done if the prime is congruent to 1 mod 4.

    @@ -2393,7 +2393,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.sqf_normal(a, b, c, steps=False)[source]
    +sympy.solvers.diophantine.diophantine.sqf_normal(a, b, c, steps=False)[source]

    Return \(a', b', c'\), the coefficients of the square-free normal form of \(ax^2 + by^2 + cz^2 = 0\), where \(a', b', c'\) are pairwise prime. If \(steps\) is True then also return three tuples: @@ -2427,7 +2427,7 @@

    Internal Functions
    -sympy.solvers.diophantine.diophantine.reconstruct(A, B, z)[source]
    +sympy.solvers.diophantine.diophantine.reconstruct(A, B, z)[source]

    Reconstruct the \(z\) value of an equivalent solution of \(ax^2 + by^2 + cz^2\) from the \(z\) value of a solution of the square-free normal form of the equation, \(a'*x^2 + b'*y^2 + c'*z^2\), where \(a'\), \(b'\) and \(c'\) are square @@ -2440,7 +2440,7 @@

    Internal Classes
    -class sympy.solvers.diophantine.diophantine.DiophantineSolutionSet(symbols_seq, parameters)[source]
    +class sympy.solvers.diophantine.diophantine.DiophantineSolutionSet(symbols_seq, parameters)[source]

    Container for a set of solutions to a particular diophantine equation.

    The base representation is a set of tuples representing each of the solutions.

    @@ -2511,7 +2511,7 @@

    Internal Classesfree_symbols=None,

    -)[source] +)[source]

    Internal representation of a particular diophantine equation type.

    Parameters:
    @@ -2546,7 +2546,7 @@

    Internal Classes
    -matches()[source]
    +matches()[source]

    Determine whether the given equation can be matched to the particular equation type.

    @@ -2554,7 +2554,7 @@

    Internal Classes
    -class sympy.solvers.diophantine.diophantine.Univariate(equation, free_symbols=None)[source]
    +class sympy.solvers.diophantine.diophantine.Univariate(equation, free_symbols=None)[source]

    Representation of a univariate diophantine equation.

    A univariate diophantine equation is an equation of the form \(a_{0} + a_{1}x + a_{2}x^2 + .. + a_{n}x^n = 0\) where \(a_{1}, a_{2}, ..a_{n}\) are @@ -2570,7 +2570,7 @@

    Internal Classes
    -class sympy.solvers.diophantine.diophantine.Linear(equation, free_symbols=None)[source]
    +class sympy.solvers.diophantine.diophantine.Linear(equation, free_symbols=None)[source]

    Representation of a linear diophantine equation.

    A linear diophantine equation is an equation of the form \(a_{1}x_{1} + a_{2}x_{2} + .. + a_{n}x_{n} = 0\) where \(a_{1}, a_{2}, ..a_{n}\) are @@ -2594,7 +2594,7 @@

    Internal Classes
    -class sympy.solvers.diophantine.diophantine.BinaryQuadratic(equation, free_symbols=None)[source]
    +class sympy.solvers.diophantine.diophantine.BinaryQuadratic(equation, free_symbols=None)[source]

    Representation of a binary quadratic diophantine equation.

    A binary quadratic diophantine equation is an equation of the form \(Ax^2 + Bxy + Cy^2 + Dx + Ey + F = 0\), where \(A, B, C, D, E, @@ -2636,7 +2636,7 @@

    Internal Classesfree_symbols=None,

    -)[source] +)[source]

    Representation of an inhomogeneous ternary quadratic.

    No solver is currently implemented for this equation type.

    @@ -2650,7 +2650,7 @@

    Internal Classesfree_symbols=None,

    -)[source] +)[source]

    Representation of a homogeneous ternary quadratic normal diophantine equation.

    Examples

    >>> from sympy.abc import x, y, z
    @@ -2670,7 +2670,7 @@ 

    Internal Classesfree_symbols=None,

    -)[source] +)[source]

    Representation of a homogeneous ternary quadratic diophantine equation.

    Examples

    >>> from sympy.abc import x, y, z
    @@ -2692,7 +2692,7 @@ 

    Internal Classesfree_symbols=None,

    -)[source] +)[source]

    Representation of an inhomogeneous general quadratic.

    No solver is currently implemented for this equation type.

    @@ -2706,14 +2706,14 @@

    Internal Classesfree_symbols=None,

    -)[source] +)[source]

    Representation of a homogeneous general quadratic.

    No solver is currently implemented for this equation type.

    -class sympy.solvers.diophantine.diophantine.GeneralSumOfSquares(equation, free_symbols=None)[source]
    +class sympy.solvers.diophantine.diophantine.GeneralSumOfSquares(equation, free_symbols=None)[source]

    Representation of the diophantine equation

    \(x_{1}^2 + x_{2}^2 + . . . + x_{n}^2 - k = 0\).

    Details

    @@ -2745,7 +2745,7 @@

    Internal Classes
    -class sympy.solvers.diophantine.diophantine.GeneralPythagorean(equation, free_symbols=None)[source]
    +class sympy.solvers.diophantine.diophantine.GeneralPythagorean(equation, free_symbols=None)[source]

    Representation of the general pythagorean equation, \(a_{1}^2x_{1}^2 + a_{2}^2x_{2}^2 + . . . + a_{n}^2x_{n}^2 - a_{n + 1}^2x_{n + 1}^2 = 0\).

    Examples

    @@ -2761,7 +2761,7 @@

    Internal Classes
    -class sympy.solvers.diophantine.diophantine.CubicThue(equation, free_symbols=None)[source]
    +class sympy.solvers.diophantine.diophantine.CubicThue(equation, free_symbols=None)[source]

    Representation of a cubic Thue diophantine equation.

    A cubic Thue diophantine equation is a polynomial of the form \(f(x, y) = r\) of degree 3, where \(x\) and \(y\) are integers @@ -2786,7 +2786,7 @@

    Internal Classesfree_symbols=None,

    -)[source] +)[source]

    Representation of the diophantine equation

    \(x_{1}^e + x_{2}^e + . . . + x_{n}^e - k = 0\)

    where \(e\) is an even, integer power.

    diff --git a/dev/modules/solvers/inequalities.html b/dev/modules/solvers/inequalities.html index 5eb8afe3a1e..afc88c2dd5d 100644 --- a/dev/modules/solvers/inequalities.html +++ b/dev/modules/solvers/inequalities.html @@ -819,7 +819,7 @@
    Documentation Version
    -sympy.solvers.inequalities.solve_rational_inequalities(eqs)[source]
    +sympy.solvers.inequalities.solve_rational_inequalities(eqs)[source]

    Solve a system of rational inequalities with rational coefficients.

    Examples

    >>> from sympy.abc import x
    @@ -846,7 +846,7 @@ 
    Documentation Version
    -sympy.solvers.inequalities.solve_poly_inequality(poly, rel)[source]
    +sympy.solvers.inequalities.solve_poly_inequality(poly, rel)[source]

    Solve a polynomial inequality with rational coefficients.

    Examples

    >>> from sympy import solve_poly_inequality, Poly
    @@ -873,7 +873,7 @@ 
    Documentation Version
    -sympy.solvers.inequalities.solve_poly_inequalities(polys)[source]
    +sympy.solvers.inequalities.solve_poly_inequalities(polys)[source]

    Solve polynomial inequalities with rational coefficients.

    Examples

    >>> from sympy import Poly
    @@ -897,7 +897,7 @@ 
    Documentation Version
    relational=True,
    -)[source] +)[source]

    Reduce a system of rational inequalities with rational coefficients.

    Examples

    >>> from sympy import Symbol
    @@ -931,7 +931,7 @@ 
    Documentation Version
    -sympy.solvers.inequalities.reduce_abs_inequality(expr, rel, gen)[source]
    +sympy.solvers.inequalities.reduce_abs_inequality(expr, rel, gen)[source]

    Reduce an inequality with nested absolute values.

    Examples

    >>> from sympy import reduce_abs_inequality, Abs, Symbol
    @@ -954,7 +954,7 @@ 
    Documentation Version
    -sympy.solvers.inequalities.reduce_abs_inequalities(exprs, gen)[source]
    +sympy.solvers.inequalities.reduce_abs_inequalities(exprs, gen)[source]

    Reduce a system of inequalities with nested absolute values.

    Examples

    >>> from sympy import reduce_abs_inequalities, Abs, Symbol
    @@ -978,7 +978,7 @@ 
    Documentation Version
    -sympy.solvers.inequalities.reduce_inequalities(inequalities, symbols=[])[source]
    +sympy.solvers.inequalities.reduce_inequalities(inequalities, symbols=[])[source]

    Reduce a system of inequalities with rational coefficients.

    Examples

    >>> from sympy.abc import x, y
    @@ -1007,7 +1007,7 @@ 
    Documentation Version
    continuous=False,
    -)[source] +)[source]

    Solves a real univariate inequality.

    Parameters:
    diff --git a/dev/modules/solvers/ode.html b/dev/modules/solvers/ode.html index 25e518c5c1d..163dec28b87 100644 --- a/dev/modules/solvers/ode.html +++ b/dev/modules/solvers/ode.html @@ -830,7 +830,7 @@
    Documentation Version
    **kwargs,
    -)[source] +)[source]

    Solves any (supported) kind of ordinary differential equation and system of ordinary differential equations.

    For Single Ordinary Differential Equation

    @@ -1028,7 +1028,7 @@
    Documentation Version
    simplify=True,
    -)[source] +)[source]

    Solves any(supported) system of Ordinary Differential Equations

    Parameters:
    @@ -1142,7 +1142,7 @@
    Documentation Version
    **kwargs,
    -)[source] +)[source]

    Returns a tuple of possible dsolve() classifications for an ODE.

    The tuple is ordered so that first item is the classification that @@ -1270,7 +1270,7 @@

    Documentation Version
    solve_for_func=True,
    -)[source] +)[source]

    Substitutes sol into ode and checks that the result is 0.

    This works when func is one function, like \(f(x)\) or a list of functions like \([f(x), g(x)]\) when \(ode\) is a system of ODEs. sol can @@ -1331,7 +1331,7 @@

    Documentation Version
    -sympy.solvers.ode.homogeneous_order(eq, *symbols)[source]
    +sympy.solvers.ode.homogeneous_order(eq, *symbols)[source]

    Returns the order \(n\) if \(g\) is homogeneous and None if it is not homogeneous.

    Determines if a function is homogeneous and if so of what order. A @@ -1379,7 +1379,7 @@

    Documentation Version
    match=None,
    -)[source] +)[source]

    The infinitesimal functions of an ordinary differential equation, \(\xi(x,y)\) and \(\eta(x,y)\), are the infinitesimals of the Lie group of point transformations for which the differential equation is invariant. So, the ODE \(y'=f(x,y)\) @@ -1448,7 +1448,7 @@

    Documentation Version
    order=None,
    -)[source] +)[source]

    This function is used to check if the given infinitesimals are the actual infinitesimals of the given first order differential equation. This method is specific to the Lie Group Solver of ODEs.

    @@ -1472,7 +1472,7 @@
    Documentation Version
    -sympy.solvers.ode.constantsimp(expr, constants)[source]
    +sympy.solvers.ode.constantsimp(expr, constants)[source]

    Simplifies an expression with arbitrary constants in it.

    This function is written specifically to work with dsolve(), and is not intended for general use.

    @@ -1546,7 +1546,7 @@
    Documentation Version
    -sympy.solvers.ode.ode.odesimp(ode, eq, func, hint)[source]
    +sympy.solvers.ode.ode.odesimp(ode, eq, func, hint)[source]

    Simplifies solutions of ODEs, including trying to solve for func and running constantsimp().

    It may use knowledge of the type of solution that the hint returns to @@ -1610,7 +1610,7 @@

    Documentation Version
    newconstants=None,
    -)[source] +)[source]

    Renumber arbitrary constants in expr to use the symbol names as given in newconstants. In the process, this reorders expression terms in a standard way.

    @@ -1654,7 +1654,7 @@
    Documentation Version
    -sympy.solvers.ode.ode.ode_sol_simplicity(sol, func, trysolving=True)[source]
    +sympy.solvers.ode.ode.ode_sol_simplicity(sol, func, trysolving=True)[source]

    Returns an extended integer representing how simple a solution to an ODE is.

    The following things are considered, in order from most simple to least:

    @@ -1735,7 +1735,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.Factorable(ode_problem)[source]
    +class sympy.solvers.ode.single.Factorable(ode_problem)[source]

    Solves equations having a solvable factor.

    This function is used to solve the equation having factors. Factors may be of type algebraic or ode. It will try to solve each factor independently. Factors will be solved by calling dsolve. We will return the @@ -1754,7 +1754,7 @@

    Documentation Version
    -class sympy.solvers.ode.single.FirstExact(ode_problem)[source]
    +class sympy.solvers.ode.single.FirstExact(ode_problem)[source]

    Solves 1st order exact ordinary differential equations.

    A 1st order differential equation is called exact if it is the total differential of a function. That is, the differential equation

    @@ -1807,7 +1807,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.HomogeneousCoeffBest(ode_problem)[source]
    +class sympy.solvers.ode.single.HomogeneousCoeffBest(ode_problem)[source]

    Returns the best solution to an ODE from the two hints 1st_homogeneous_coeff_subs_dep_div_indep and 1st_homogeneous_coeff_subs_indep_div_dep.

    @@ -1844,7 +1844,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.HomogeneousCoeffSubsDepDivIndep(ode_problem)[source]
    +class sympy.solvers.ode.single.HomogeneousCoeffSubsDepDivIndep(ode_problem)[source]

    Solves a 1st order differential equation with homogeneous coefficients using the substitution \(u_1 = \frac{\text{<dependent variable>}}{\text{<independent variable>}}\).

    @@ -1917,7 +1917,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.HomogeneousCoeffSubsIndepDivDep(ode_problem)[source]
    +class sympy.solvers.ode.single.HomogeneousCoeffSubsIndepDivDep(ode_problem)[source]

    Solves a 1st order differential equation with homogeneous coefficients using the substitution \(u_2 = \frac{\text{<independent variable>}}{\text{<dependent variable>}}\).

    @@ -1993,7 +1993,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.FirstLinear(ode_problem)[source]
    +class sympy.solvers.ode.single.FirstLinear(ode_problem)[source]

    Solves 1st order linear differential equations.

    These are differential equations of the form

    @@ -2042,7 +2042,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.RationalRiccati(ode_problem)[source]
    +class sympy.solvers.ode.single.RationalRiccati(ode_problem)[source]

    Gives general solutions to the first order Riccati differential equations that have atleast one rational particular solution.

    @@ -2075,7 +2075,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.SecondLinearAiry(ode_problem)[source]
    +class sympy.solvers.ode.single.SecondLinearAiry(ode_problem)[source]

    Gives solution of the Airy differential equation

    @@ -2095,7 +2095,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.SecondLinearBessel(ode_problem)[source]
    +class sympy.solvers.ode.single.SecondLinearBessel(ode_problem)[source]

    Gives solution of the Bessel differential equation

    @@ -2124,7 +2124,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.Bernoulli(ode_problem)[source]
    +class sympy.solvers.ode.single.Bernoulli(ode_problem)[source]

    Solves Bernoulli differential equations.

    These are equations of the form

    @@ -2196,7 +2196,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.Liouville(ode_problem)[source]
    +class sympy.solvers.ode.single.Liouville(ode_problem)[source]

    Solves 2nd order Liouville differential equations.

    The general form of a Liouville ODE is

    @@ -2252,7 +2252,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.RiccatiSpecial(ode_problem)[source]
    +class sympy.solvers.ode.single.RiccatiSpecial(ode_problem)[source]

    The general Riccati equation has the form

    @@ -2294,7 +2294,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.NthLinearConstantCoeffHomogeneous(ode_problem)[source]
    +class sympy.solvers.ode.single.NthLinearConstantCoeffHomogeneous(ode_problem)[source]

    Solves an \(n\)th order linear homogeneous differential equation with constant coefficients.

    This is an equation of the form

    @@ -2361,7 +2361,7 @@
    Documentation Version
    ode_problem,
    -)[source] +)[source]

    Solves an \(n\)th order linear differential equation with constant coefficients using the method of undetermined coefficients.

    This method works on differential equations of the form

    @@ -2420,7 +2420,7 @@
    Documentation Version
    ode_problem,
    -)[source] +)[source]

    Solves an \(n\)th order linear differential equation with constant coefficients using the method of variation of parameters.

    This method works on any differential equations of the form

    @@ -2487,7 +2487,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.NthLinearEulerEqHomogeneous(ode_problem)[source]
    +class sympy.solvers.ode.single.NthLinearEulerEqHomogeneous(ode_problem)[source]

    Solves an \(n\)th order linear homogeneous variable-coefficient Cauchy-Euler equidimensional ordinary differential equation.

    This is an equation with form \(0 = a_0 f(x) + a_1 x f'(x) + a_2 x^2 f''(x) @@ -2556,7 +2556,7 @@

    Documentation Version
    ode_problem,
    -)[source] +)[source]

    Solves an \(n\)th order linear non homogeneous Cauchy-Euler equidimensional ordinary differential equation using variation of parameters.

    This is an equation with form \(g(x) = a_0 f(x) + a_1 x f'(x) + a_2 x^2 f''(x) @@ -2614,7 +2614,7 @@

    Documentation Version
    ode_problem,
    -)[source] +)[source]

    Solves an \(n\)th order linear non homogeneous Cauchy-Euler equidimensional ordinary differential equation using undetermined coefficients.

    This is an equation with form \(g(x) = a_0 f(x) + a_1 x f'(x) + a_2 x^2 f''(x) @@ -2656,7 +2656,7 @@

    Documentation Version
    -class sympy.solvers.ode.single.NthAlgebraic(ode_problem)[source]
    +class sympy.solvers.ode.single.NthAlgebraic(ode_problem)[source]

    Solves an \(n\)th order ordinary differential equation using algebra and integrals.

    There is no general form for the kind of equation that this can solve. The @@ -2677,7 +2677,7 @@

    Documentation Version
    -class sympy.solvers.ode.single.NthOrderReducible(ode_problem)[source]
    +class sympy.solvers.ode.single.NthOrderReducible(ode_problem)[source]

    Solves ODEs that only involve derivatives of the dependent variable using a substitution of the form \(f^n(x) = g(x)\).

    For example any second order ODE of the form \(f''(x) = h(f'(x), x)\) can be @@ -2699,7 +2699,7 @@

    Documentation Version
    -class sympy.solvers.ode.single.Separable(ode_problem)[source]
    +class sympy.solvers.ode.single.Separable(ode_problem)[source]

    Solves separable 1st order differential equations.

    This is any differential equation that can be written as \(P(y) \tfrac{dy}{dx} = Q(x)\). The solution can then just be found by @@ -2752,7 +2752,7 @@

    Documentation Version
    -class sympy.solvers.ode.single.AlmostLinear(ode_problem)[source]
    +class sympy.solvers.ode.single.AlmostLinear(ode_problem)[source]

    Solves an almost-linear differential equation.

    The general form of an almost linear differential equation is

    @@ -2798,7 +2798,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.LinearCoefficients(ode_problem)[source]
    +class sympy.solvers.ode.single.LinearCoefficients(ode_problem)[source]

    Solves a differential equation with linear coefficients.

    The general form of a differential equation with linear coefficients is

    @@ -2843,7 +2843,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.SeparableReduced(ode_problem)[source]
    +class sympy.solvers.ode.single.SeparableReduced(ode_problem)[source]

    Solves a differential equation that can be reduced to the separable form.

    The general form of this equation is

    @@ -2904,7 +2904,7 @@
    Documentation Version
    -class sympy.solvers.ode.single.LieGroup(ode_problem)[source]
    +class sympy.solvers.ode.single.LieGroup(ode_problem)[source]

    This hint implements the Lie group method of solving first order differential equations. The aim is to convert the given differential equation from the given coordinate system into another coordinate system where it becomes @@ -2954,7 +2954,7 @@

    Documentation Version
    -class sympy.solvers.ode.single.SecondHypergeometric(ode_problem)[source]
    +class sympy.solvers.ode.single.SecondHypergeometric(ode_problem)[source]

    Solves 2nd order linear differential equations.

    It computes special function solutions which can be expressed using the 2F1, 1F1 or 0F1 hypergeometric functions.

    @@ -3003,7 +3003,7 @@
    Documentation Version
    -sympy.solvers.ode.ode.ode_1st_power_series(eq, func, order, match)[source]
    +sympy.solvers.ode.ode.ode_1st_power_series(eq, func, order, match)[source]

    The power series solution is a method which gives the Taylor series expansion to the solution of a differential equation.

    For a first order differential equation \(\frac{dy}{dx} = h(x, y)\), a power @@ -3050,7 +3050,7 @@

    Documentation Version
    match,
    -)[source] +)[source]

    Gives a power series solution to a second order homogeneous differential equation with polynomial coefficients at an ordinary point. A homogeneous differential equation is of the form

    @@ -3094,7 +3094,7 @@
    Documentation Version
    match,
    -)[source] +)[source]

    Gives a power series solution to a second order homogeneous differential equation with polynomial coefficients at a regular point. A second order homogeneous differential equation is of the form

    @@ -3153,7 +3153,7 @@

    Lie heuristics
    -sympy.solvers.ode.lie_group.lie_heuristic_abaco1_simple(match, comp=False)[source]
    +sympy.solvers.ode.lie_group.lie_heuristic_abaco1_simple(match, comp=False)[source]

    The first heuristic uses the following four sets of assumptions on \(\xi\) and \(\eta\)

    @@ -3193,7 +3193,7 @@

    Lie heuristics
    -sympy.solvers.ode.lie_group.lie_heuristic_abaco1_product(match, comp=False)[source]
    +sympy.solvers.ode.lie_group.lie_heuristic_abaco1_product(match, comp=False)[source]

    The second heuristic uses the following two assumptions on \(\xi\) and \(\eta\)

    @@ -3226,7 +3226,7 @@

    Lie heuristics
    -sympy.solvers.ode.lie_group.lie_heuristic_bivariate(match, comp=False)[source]
    +sympy.solvers.ode.lie_group.lie_heuristic_bivariate(match, comp=False)[source]

    The third heuristic assumes the infinitesimals \(\xi\) and \(\eta\) to be bi-variate polynomials in \(x\) and \(y\). The assumption made here for the logic below is that \(h\) is a rational function in \(x\) and \(y\) @@ -3245,7 +3245,7 @@

    Lie heuristics
    -sympy.solvers.ode.lie_group.lie_heuristic_chi(match, comp=False)[source]
    +sympy.solvers.ode.lie_group.lie_heuristic_chi(match, comp=False)[source]

    The aim of the fourth heuristic is to find the function \(\chi(x, y)\) that satisfies the PDE \(\frac{d\chi}{dx} + h\frac{d\chi}{dx} - \frac{\partial h}{\partial y}\chi = 0\).

    @@ -3266,7 +3266,7 @@

    Lie heuristics
    -sympy.solvers.ode.lie_group.lie_heuristic_abaco2_similar(match, comp=False)[source]
    +sympy.solvers.ode.lie_group.lie_heuristic_abaco2_similar(match, comp=False)[source]

    This heuristic uses the following two assumptions on \(\xi\) and \(\eta\)

    @@ -3304,7 +3304,7 @@

    Lie heuristics
    -sympy.solvers.ode.lie_group.lie_heuristic_function_sum(match, comp=False)[source]
    +sympy.solvers.ode.lie_group.lie_heuristic_function_sum(match, comp=False)[source]

    This heuristic uses the following two assumptions on \(\xi\) and \(\eta\)

    @@ -3351,7 +3351,7 @@

    Lie heuristicscomp=False,

    -)[source] +)[source]

    This heuristic assumes the presence of unknown functions or known functions with non-integer powers.

      @@ -3387,7 +3387,7 @@

      Lie heuristicscomp=False,

    -)[source] +)[source]

    This heuristic finds if infinitesimals of the form \(\eta = f(x)\), \(\xi = g(y)\) without making any assumptions on \(h\).

    The complete sequence of steps is given in the paper mentioned below.

    @@ -3400,7 +3400,7 @@

    Lie heuristics
    -sympy.solvers.ode.lie_group.lie_heuristic_linear(match, comp=False)[source]
    +sympy.solvers.ode.lie_group.lie_heuristic_linear(match, comp=False)[source]

    This heuristic assumes

    1. \(\xi = ax + by + c\) and

    2. @@ -3431,7 +3431,7 @@

      Rational Riccati Solver
      -sympy.solvers.ode.riccati.riccati_normal(w, x, b1, b2)[source]
      +sympy.solvers.ode.riccati.riccati_normal(w, x, b1, b2)[source]

      Given a solution \(w(x)\) to the equation

      @@ -3454,28 +3454,28 @@

      Rational Riccati Solver
      -sympy.solvers.ode.riccati.riccati_inverse_normal(y, x, b1, b2, bp=None)[source]
      +sympy.solvers.ode.riccati.riccati_inverse_normal(y, x, b1, b2, bp=None)[source]

      Inverse transforming the solution to the normal Riccati ODE to get the solution to the Riccati ODE.

      -sympy.solvers.ode.riccati.riccati_reduced(eq, f, x)[source]
      +sympy.solvers.ode.riccati.riccati_reduced(eq, f, x)[source]

      Convert a Riccati ODE into its corresponding normal Riccati ODE.

      -sympy.solvers.ode.riccati.construct_c(num, den, x, poles, muls)[source]
      +sympy.solvers.ode.riccati.construct_c(num, den, x, poles, muls)[source]

      Helper function to calculate the coefficients in the c-vector for each pole.

      -sympy.solvers.ode.riccati.construct_d(num, den, x, val_inf)[source]
      +sympy.solvers.ode.riccati.construct_d(num, den, x, val_inf)[source]

      Helper function to calculate the coefficients in the d-vector based on the valuation of the function at oo.

      @@ -3483,7 +3483,7 @@

      Rational Riccati Solver
      -sympy.solvers.ode.riccati.rational_laurent_series(num, den, x, r, m, n)[source]
      +sympy.solvers.ode.riccati.rational_laurent_series(num, den, x, r, m, n)[source]

      The function computes the Laurent series coefficients of a rational function.

      @@ -3528,7 +3528,7 @@

      Rational Riccati Solver
      -sympy.solvers.ode.riccati.compute_m_ybar(x, poles, choice, N)[source]
      +sympy.solvers.ode.riccati.compute_m_ybar(x, poles, choice, N)[source]

      Helper function to calculate -

      1. m - The degree bound for the polynomial solution that must be found for the auxiliary @@ -3539,7 +3539,7 @@

      Rational Riccati Solver
      -sympy.solvers.ode.riccati.solve_aux_eq(numa, dena, numy, deny, x, m)[source]
      +sympy.solvers.ode.riccati.solve_aux_eq(numa, dena, numy, deny, x, m)[source]

      Helper function to find a polynomial solution of degree m for the auxiliary differential equation.

      @@ -3547,14 +3547,14 @@

      Rational Riccati Solver
      -sympy.solvers.ode.riccati.remove_redundant_sols(sol1, sol2, x)[source]
      +sympy.solvers.ode.riccati.remove_redundant_sols(sol1, sol2, x)[source]

      Helper function to remove redundant solutions to the differential equation.

      -sympy.solvers.ode.riccati.get_gen_sol_from_part_sol(part_sols, a, x)[source]
      +sympy.solvers.ode.riccati.get_gen_sol_from_part_sol(part_sols, a, x)[source]

      ” Helper function which computes the general solution for a Riccati ODE from its particular @@ -3570,7 +3570,7 @@

      Rational Riccati Solver
      -sympy.solvers.ode.riccati.solve_riccati(fx, x, b0, b1, b2, gensol=False)[source]
      +sympy.solvers.ode.riccati.solve_riccati(fx, x, b0, b1, b2, gensol=False)[source]

      The main function that gives particular/general solutions to Riccati ODEs that have atleast 1 rational particular solution.

      @@ -3583,7 +3583,7 @@

      System of ODEsdsolve() for system of differential equations.

      -sympy.solvers.ode.ode._linear_2eq_order1_type6(x, y, t, r, eq)[source]
      +sympy.solvers.ode.ode._linear_2eq_order1_type6(x, y, t, r, eq)[source]

      The equations of this type of ode are .

      @@ -3610,7 +3610,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._linear_2eq_order1_type7(x, y, t, r, eq)[source]
      +sympy.solvers.ode.ode._linear_2eq_order1_type7(x, y, t, r, eq)[source]

      The equations of this type of ode are .

      @@ -3653,7 +3653,7 @@

      System of ODEs
      -sympy.solvers.ode.systems.linear_ode_to_matrix(eqs, funcs, t, order)[source]
      +sympy.solvers.ode.systems.linear_ode_to_matrix(eqs, funcs, t, order)[source]

      Convert a linear system of ODEs to matrix form

      Parameters:
      @@ -3782,7 +3782,7 @@

      System of ODEs
      -sympy.solvers.ode.systems.canonical_odes(eqs, funcs, t)[source]
      +sympy.solvers.ode.systems.canonical_odes(eqs, funcs, t)[source]

      Function that solves for highest order derivatives in a system

      Parameters:
      @@ -3843,7 +3843,7 @@

      System of ODEs
      -sympy.solvers.ode.systems.linodesolve_type(A, t, b=None)[source]
      +sympy.solvers.ode.systems.linodesolve_type(A, t, b=None)[source]

      Helper function that determines the type of the system of ODEs for solving with sympy.solvers.ode.systems.linodesolve()

      Parameters:
      @@ -3932,7 +3932,7 @@

      System of ODEs
      -sympy.solvers.ode.systems.matrix_exp_jordan_form(A, t)[source]
      +sympy.solvers.ode.systems.matrix_exp_jordan_form(A, t)[source]

      Matrix exponential \(\exp(A*t)\) for the matrix A and scalar t.

      Parameters:
      @@ -3993,7 +3993,7 @@

      System of ODEs
      -sympy.solvers.ode.systems.matrix_exp(A, t)[source]
      +sympy.solvers.ode.systems.matrix_exp(A, t)[source]

      Matrix exponential \(\exp(A*t)\) for the matrix A and scalar t.

      Parameters:
      @@ -4089,7 +4089,7 @@

      System of ODEstau=None,

      -)[source] +)[source]

      System of n equations linear first-order differential equations

      Parameters:
      @@ -4308,7 +4308,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_2eq_order1_type1(x, y, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_2eq_order1_type1(x, y, t, eq)[source]

      Equations:

      @@ -4339,7 +4339,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_2eq_order1_type2(x, y, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_2eq_order1_type2(x, y, t, eq)[source]

      Equations:

      @@ -4370,7 +4370,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_2eq_order1_type3(x, y, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_2eq_order1_type3(x, y, t, eq)[source]

      Autonomous system of general form

      @@ -4395,7 +4395,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_2eq_order1_type4(x, y, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_2eq_order1_type4(x, y, t, eq)[source]

      Equation:

      @@ -4418,7 +4418,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_2eq_order1_type5(func, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_2eq_order1_type5(func, t, eq)[source]

      Clairaut system of ODEs

      @@ -4442,7 +4442,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_3eq_order1_type1(x, y, z, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_3eq_order1_type1(x, y, z, t, eq)[source]

      Equations:

      @@ -4467,7 +4467,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_3eq_order1_type2(x, y, z, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_3eq_order1_type2(x, y, z, t, eq)[source]

      Equations:

      @@ -4500,7 +4500,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_3eq_order1_type3(x, y, z, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_3eq_order1_type3(x, y, z, t, eq)[source]

      Equations:

      @@ -4530,7 +4530,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_3eq_order1_type4(x, y, z, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_3eq_order1_type4(x, y, z, t, eq)[source]

      Equations:

      @@ -4560,7 +4560,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._nonlinear_3eq_order1_type5(x, y, z, t, eq)[source]
      +sympy.solvers.ode.ode._nonlinear_3eq_order1_type5(x, y, z, t, eq)[source]
      \[x' = x (c F_2 - b F_3), \enspace y' = y (a F_3 - c F_1), \enspace z' = z (b F_1 - a F_2)\]
      @@ -4798,7 +4798,7 @@

      System of ODEs
      -sympy.solvers.ode.ode._handle_Integral(expr, func, hint)[source]
      +sympy.solvers.ode.ode._handle_Integral(expr, func, hint)[source]

      Converts a solution with Integrals in it into an actual solution.

      For most hints, this simply runs expr.doit().

      diff --git a/dev/modules/solvers/pde.html b/dev/modules/solvers/pde.html index 6169435963f..155a1b79b1e 100644 --- a/dev/modules/solvers/pde.html +++ b/dev/modules/solvers/pde.html @@ -808,7 +808,7 @@

      User Functionsfrom sympy import *. They are intended for user use.

      -sympy.solvers.pde.pde_separate(eq, fun, sep, strategy='mul')[source]
      +sympy.solvers.pde.pde_separate(eq, fun, sep, strategy='mul')[source]

      Separate variables in partial differential equation either by additive or multiplicative separation approach. It tries to rewrite an equation so that one of the specified variables occurs on a different side of the @@ -849,7 +849,7 @@

      User Functions
      -sympy.solvers.pde.pde_separate_add(eq, fun, sep)[source]
      +sympy.solvers.pde.pde_separate_add(eq, fun, sep)[source]

      Helper function for searching additive separable solutions.

      Consider an equation of two independent variables x, y and a dependent variable w, we look for the product of two functions depending on different @@ -870,7 +870,7 @@

      User Functions
      -sympy.solvers.pde.pde_separate_mul(eq, fun, sep)[source]
      +sympy.solvers.pde.pde_separate_mul(eq, fun, sep)[source]

      Helper function for searching multiplicative separable solutions.

      Consider an equation of two independent variables x, y and a dependent variable w, we look for the product of two functions depending on different @@ -902,7 +902,7 @@

      User Functions**kwargs,

      -)[source] +)[source]

      Solves any (supported) kind of partial differential equation.

      Usage

      @@ -1015,7 +1015,7 @@

      User Functions**kwargs,

      -)[source] +)[source]

      Returns a tuple of possible pdsolve() classifications for a PDE.

      The tuple is ordered so that first item is the classification that pdsolve() uses to solve the PDE by default. In general, @@ -1058,7 +1058,7 @@

      User Functionssolve_for_func=True,

      -)[source] +)[source]

      Checks if the given solution satisfies the partial differential equation.

      pde is the partial differential equation which can be given in the @@ -1112,7 +1112,7 @@

      Hint Methodssolvefun,

      -)[source] +)[source]

      Solves a first order linear homogeneous partial differential equation with constant coefficients.

      The general form of this partial differential equation is

      @@ -1182,7 +1182,7 @@

      Hint Methodssolvefun,

      -)[source] +)[source]

      Solves a first order linear partial differential equation with constant coefficients.

      The general form of this partial differential equation is

      @@ -1267,7 +1267,7 @@

      Hint Methodssolvefun,

      -)[source] +)[source]

      Solves a first order linear partial differential equation with variable coefficients. The general form of this partial differential equation is

      diff --git a/dev/modules/solvers/solvers.html b/dev/modules/solvers/solvers.html index 930a8c46091..84ce27c5be8 100644 --- a/dev/modules/solvers/solvers.html +++ b/dev/modules/solvers/solvers.html @@ -835,7 +835,7 @@
      Documentation Version
      is the symbol that we want to solve the equation for.

      -sympy.solvers.solvers.solve(f, *symbols, **flags)[source]
      +sympy.solvers.solvers.solve(f, *symbols, **flags)[source]

      Algebraically solves equations and systems of equations.

      Parameters:
      @@ -1325,7 +1325,7 @@
      Documentation Version
      -sympy.solvers.solvers.solve_linear(lhs, rhs=0, symbols=[], exclude=[])[source]
      +sympy.solvers.solvers.solve_linear(lhs, rhs=0, symbols=[], exclude=[])[source]

      Return a tuple derived from f = lhs - rhs that is one of the following: (0, 1), (0, 0), (symbol, solution), (n, d).

      Explanation

      @@ -1425,7 +1425,7 @@
      Documentation Version
      -sympy.solvers.solvers.solve_linear_system(system, *symbols, **flags)[source]
      +sympy.solvers.solvers.solve_linear_system(system, *symbols, **flags)[source]

      Solve system of \(N\) linear equations with \(M\) variables, which means both under- and overdetermined systems are supported.

      Explanation

      @@ -1468,7 +1468,7 @@
      Documentation Version
      -sympy.solvers.solvers.solve_linear_system_LU(matrix, syms)[source]
      +sympy.solvers.solvers.solve_linear_system_LU(matrix, syms)[source]

      Solves the augmented matrix system using LUsolve and returns a dictionary in which solutions are keyed to the symbols of syms as ordered.

      Explanation

      @@ -1502,7 +1502,7 @@
      Documentation Version
      **flags,
      -)[source] +)[source]

      Solve a system of equations in \(k\) parameters that is formed by matching coefficients in variables coeffs that are on factors dependent on the remaining variables (or those given @@ -1565,7 +1565,7 @@

      Documentation Version
      -sympy.solvers.solvers.nsolve(*args, dict=False, **kwargs)[source]
      +sympy.solvers.solvers.nsolve(*args, dict=False, **kwargs)[source]

      Solve a nonlinear equation system numerically: nsolve(f, [args,] x0, modules=['mpmath'], **kwargs).

      Explanation

      @@ -1667,7 +1667,7 @@
      Documentation Version
      -sympy.solvers.solvers.checksol(f, symbol, sol=None, **flags)[source]
      +sympy.solvers.solvers.checksol(f, symbol, sol=None, **flags)[source]

      Checks whether sol is a solution of equation f == 0.

      Explanation

      Input can be either a single symbol and corresponding value @@ -1715,7 +1715,7 @@

      Documentation Version
      -sympy.solvers.solvers.unrad(eq, *syms, **flags)[source]
      +sympy.solvers.solvers.unrad(eq, *syms, **flags)[source]

      Remove radicals with symbolic arguments and return (eq, cov), None, or raise an error.

      Explanation

      @@ -1790,7 +1790,7 @@

      Partial Differential Equations (PDEs)

      -sympy.solvers.deutils.ode_order(expr, func)[source]
      +sympy.solvers.deutils.ode_order(expr, func)[source]

      Returns the order of a given differential equation with respect to func.

      This function is implemented recursively.

      @@ -1815,7 +1815,7 @@

      Deutils (Utilities for solving ODE’s and PDE’s)

      Recurrence Equations

      -sympy.solvers.recurr.rsolve(f, y, init=None)[source]
      +sympy.solvers.recurr.rsolve(f, y, init=None)[source]

      Solve univariate recurrence with rational coefficients.

      Given \(k\)-th order linear recurrence \(\operatorname{L} y = f\), or equivalently:

      @@ -1871,7 +1871,7 @@

      Deutils (Utilities for solving ODE’s and PDE’s)
      -sympy.solvers.recurr.rsolve_poly(coeffs, f, n, shift=0, **hints)[source]
      +sympy.solvers.recurr.rsolve_poly(coeffs, f, n, shift=0, **hints)[source]

      Given linear recurrence operator \(\operatorname{L}\) of order \(k\) with polynomial coefficients and inhomogeneous equation \(\operatorname{L} y = f\), where \(f\) is a polynomial, we seek for @@ -1932,7 +1932,7 @@

      Deutils (Utilities for solving ODE’s and PDE’s)
      -sympy.solvers.recurr.rsolve_ratio(coeffs, f, n, **hints)[source]
      +sympy.solvers.recurr.rsolve_ratio(coeffs, f, n, **hints)[source]

      Given linear recurrence operator \(\operatorname{L}\) of order \(k\) with polynomial coefficients and inhomogeneous equation \(\operatorname{L} y = f\), where \(f\) is a polynomial, we seek @@ -1985,7 +1985,7 @@

      Deutils (Utilities for solving ODE’s and PDE’s)
      -sympy.solvers.recurr.rsolve_hyper(coeffs, f, n, **hints)[source]
      +sympy.solvers.recurr.rsolve_hyper(coeffs, f, n, **hints)[source]

      Given linear recurrence operator \(\operatorname{L}\) of order \(k\) with polynomial coefficients and inhomogeneous equation \(\operatorname{L} y = f\) we seek for all hypergeometric solutions @@ -2057,7 +2057,7 @@

      Systems of Polynomial Equations**args,

      -)[source] +)[source]

      Return a list of solutions for the system of polynomial equations or else None.

      @@ -2113,7 +2113,7 @@

      Systems of Polynomial Equations
      -sympy.solvers.polysys.solve_triangulated(polys, *gens, **args)[source]
      +sympy.solvers.polysys.solve_triangulated(polys, *gens, **args)[source]

      Solve a polynomial system using Gianni-Kalkbrenner algorithm.

      The algorithm proceeds by computing one Groebner basis in the ground domain and then by iteratively computing polynomial factorizations in @@ -2173,7 +2173,7 @@

      Inequalities

      Linear Programming (Optimization)

      -sympy.solvers.simplex.lpmax(f, constr)[source]
      +sympy.solvers.simplex.lpmax(f, constr)[source]

      return maximum of linear equation f under linear constraints expressed using Ge, Le or Eq.

      All variables are unbounded unless constrained.

      @@ -2207,7 +2207,7 @@

      Inequalities
      -sympy.solvers.simplex.lpmin(f, constr)[source]
      +sympy.solvers.simplex.lpmin(f, constr)[source]

      return minimum of linear equation f under linear constraints expressed using Ge, Le or Eq.

      All variables are unbounded unless constrained.

      @@ -2254,7 +2254,7 @@

      Inequalitiesbounds=None,

      -)[source] +)[source]

      Return the minimization of c*x with the given constraints A*x <= b and A_eq*x = b_eq. Unless bounds are given, variables will have nonnegative values in the solution.

      diff --git a/dev/modules/solvers/solveset.html b/dev/modules/solvers/solveset.html index 10a554ed27a..a0f75d7edae 100644 --- a/dev/modules/solvers/solveset.html +++ b/dev/modules/solvers/solveset.html @@ -1326,7 +1326,7 @@

      Solveset Module Reference
      -sympy.solvers.solveset.solveset(f, symbol=None, domain=Complexes)[source]
      +sympy.solvers.solveset.solveset(f, symbol=None, domain=Complexes)[source]

      Solves a given inequality or equation with set as output

      Parameters:
      @@ -1442,24 +1442,24 @@

      Solveset Module Reference
      -sympy.solvers.solveset.solveset_real(f, symbol)[source]
      +sympy.solvers.solveset.solveset_real(f, symbol)[source]

      -sympy.solvers.solveset.solveset_complex(f, symbol)[source]
      +sympy.solvers.solveset.solveset_complex(f, symbol)[source]
      -sympy.solvers.solveset.invert_real(f_x, y, x)[source]
      +sympy.solvers.solveset.invert_real(f_x, y, x)[source]

      Inverts a real-valued function. Same as invert_complex(), but sets the domain to S.Reals before inverting.

      -sympy.solvers.solveset.invert_complex(f_x, y, x, domain=Complexes)[source]
      +sympy.solvers.solveset.invert_complex(f_x, y, x, domain=Complexes)[source]

      Reduce the complex valued equation \(f(x) = y\) to a set of equations

      @@ -1515,7 +1515,7 @@

      Solveset Module Reference
      -sympy.solvers.solveset.domain_check(f, symbol, p)[source]
      +sympy.solvers.solveset.domain_check(f, symbol, p)[source]

      Returns False if point p is infinite or any subexpression of f is infinite or becomes so after replacing symbol with p. If none of these conditions is met then True will be returned.

      @@ -1551,7 +1551,7 @@

      Solveset Module Reference
      -sympy.solvers.solveset.solvify(f, symbol, domain)[source]
      +sympy.solvers.solveset.solvify(f, symbol, domain)[source]

      Solves an equation using solveset and returns the solution in accordance with the \(solve\) output API.

      @@ -1593,7 +1593,7 @@

      Solveset Module Reference
      -sympy.solvers.solveset.linear_eq_to_matrix(equations, *symbols)[source]
      +sympy.solvers.solveset.linear_eq_to_matrix(equations, *symbols)[source]

      Converts a given System of Equations into Matrix form. Here equations must be a linear system of equations in symbols. Element M[i, j] corresponds to the coefficient of the jth symbol in the ith equation.

      @@ -1678,7 +1678,7 @@

      Solveset Module Reference
      -sympy.solvers.solveset.linsolve(system, *symbols)[source]
      +sympy.solvers.solveset.linsolve(system, *symbols)[source]

      Solve system of \(N\) linear equations with \(M\) variables; both underdetermined and overdetermined systems are supported. The possible number of solutions is zero, one or infinite. @@ -1874,7 +1874,7 @@

      Solveset Module Reference
      -sympy.solvers.solveset.nonlinsolve(system, *symbols)[source]
      +sympy.solvers.solveset.nonlinsolve(system, *symbols)[source]

      Solve system of \(N\) nonlinear equations with \(M\) variables, which means both under and overdetermined systems are supported. Positive dimensional system is also supported (A system with infinitely many solutions is said @@ -2032,7 +2032,7 @@

      Solveset Module Reference

      -sympy.solvers.solveset._transolve(f, symbol, domain)[source]
      +sympy.solvers.solveset._transolve(f, symbol, domain)[source]

      Function to solve transcendental equations. It is a helper to solveset and should be used internally. _transolve currently supports the following class of equations:

      @@ -2205,7 +2205,7 @@

      transolve
      -sympy.solvers.solveset._is_exponential(f, symbol)[source]
      +sympy.solvers.solveset._is_exponential(f, symbol)[source]

      Return True if one or more terms contain symbol only in exponents, else False.

      @@ -2245,7 +2245,7 @@

      transolve
      -sympy.solvers.solveset._solve_exponential(lhs, rhs, symbol, domain)[source]
      +sympy.solvers.solveset._solve_exponential(lhs, rhs, symbol, domain)[source]

      Helper function for solving (supported) exponential equations.

      Exponential equations are the sum of (currently) at most two terms with one or both of them having a power with a @@ -2325,7 +2325,7 @@

      transolve
      -sympy.solvers.solveset._solve_logarithm(lhs, rhs, symbol, domain)[source]
      +sympy.solvers.solveset._solve_logarithm(lhs, rhs, symbol, domain)[source]

      Helper to solve logarithmic equations which are reducible to a single instance of \(\log\).

      Logarithmic equations are (currently) the equations that contains @@ -2416,7 +2416,7 @@

      transolve
      -sympy.solvers.solveset._is_logarithmic(f, symbol)[source]
      +sympy.solvers.solveset._is_logarithmic(f, symbol)[source]

      Return True if the equation is in the form \(a\log(f(x)) + b\log(g(x)) + ... + c\) else False.

      diff --git a/dev/modules/stats.html b/dev/modules/stats.html index e00548a9eba..675d305416c 100644 --- a/dev/modules/stats.html +++ b/dev/modules/stats.html @@ -928,7 +928,7 @@

      Random Variable TypesFinite Types

      -sympy.stats.DiscreteUniform(name, items)[source]
      +sympy.stats.DiscreteUniform(name, items)[source]

      Create a Finite Random Variable representing a uniform distribution over the input set.

      @@ -972,7 +972,7 @@

      Finite Types
      -sympy.stats.Die(name, sides=6)[source]
      +sympy.stats.Die(name, sides=6)[source]

      Create a Finite Random Variable representing a fair die.

      Parameters:
      @@ -1012,7 +1012,7 @@

      Finite Types
      -sympy.stats.Bernoulli(name, p, succ=1, fail=0)[source]
      +sympy.stats.Bernoulli(name, p, succ=1, fail=0)[source]

      Create a Finite Random Variable representing a Bernoulli process.

      Parameters:
      @@ -1063,7 +1063,7 @@

      Finite Types
      -sympy.stats.Coin(name, p=1 / 2)[source]
      +sympy.stats.Coin(name, p=1 / 2)[source]

      Create a Finite Random Variable representing a Coin toss.

      This is an equivalent of a Bernoulli random variable with “H” and “T” as success and failure events respectively.

      @@ -1108,7 +1108,7 @@

      Finite Types
      -sympy.stats.Binomial(name, n, p, succ=1, fail=0)[source]
      +sympy.stats.Binomial(name, n, p, succ=1, fail=0)[source]

      Create a Finite Random Variable representing a binomial distribution.

      Parameters:
      @@ -1167,7 +1167,7 @@

      Finite Types
      -sympy.stats.BetaBinomial(name, n, alpha, beta)[source]
      +sympy.stats.BetaBinomial(name, n, alpha, beta)[source]

      Create a Finite Random Variable representing a Beta-binomial distribution.

      Parameters:
      @@ -1206,7 +1206,7 @@

      Finite Types
      -sympy.stats.Hypergeometric(name, N, m, n)[source]
      +sympy.stats.Hypergeometric(name, N, m, n)[source]

      Create a Finite Random Variable representing a hypergeometric distribution.

      Parameters:
      @@ -1251,7 +1251,7 @@

      Finite Types
      -sympy.stats.FiniteRV(name, density, **kwargs)[source]
      +sympy.stats.FiniteRV(name, density, **kwargs)[source]

      Create a Finite Random Variable given a dict representing the density.

      Parameters:
      @@ -1292,7 +1292,7 @@

      Finite Types
      -sympy.stats.Rademacher(name)[source]
      +sympy.stats.Rademacher(name)[source]

      Create a Finite Random Variable representing a Rademacher distribution.

      Returns:
      @@ -1326,7 +1326,7 @@

      Finite Types

      -sympy.stats.Geometric(name, p)[source]
      +sympy.stats.Geometric(name, p)[source]

      Create a discrete random variable with a Geometric distribution.

      Parameters:
      @@ -1381,7 +1381,7 @@

      Discrete Types
      -sympy.stats.Hermite(name, a1, a2)[source]
      +sympy.stats.Hermite(name, a1, a2)[source]

      Create a discrete random variable with a Hermite distribution.

      Parameters:
      @@ -1435,7 +1435,7 @@

      Discrete Types
      -sympy.stats.Poisson(name, lamda)[source]
      +sympy.stats.Poisson(name, lamda)[source]

      Create a discrete random variable with a Poisson distribution.

      Parameters:
      @@ -1490,7 +1490,7 @@

      Discrete Types
      -sympy.stats.Logarithmic(name, p)[source]
      +sympy.stats.Logarithmic(name, p)[source]

      Create a discrete random variable with a Logarithmic distribution.

      Parameters:
      @@ -1545,7 +1545,7 @@

      Discrete Types
      -sympy.stats.NegativeBinomial(name, r, p)[source]
      +sympy.stats.NegativeBinomial(name, r, p)[source]

      Create a discrete random variable with a Negative Binomial distribution.

      Parameters:
      @@ -1602,7 +1602,7 @@

      Discrete Types
      -sympy.stats.Skellam(name, mu1, mu2)[source]
      +sympy.stats.Skellam(name, mu1, mu2)[source]

      Create a discrete random variable with a Skellam distribution.

      Parameters:
      @@ -1657,7 +1657,7 @@

      Discrete Types
      -sympy.stats.YuleSimon(name, rho)[source]
      +sympy.stats.YuleSimon(name, rho)[source]

      Create a discrete random variable with a Yule-Simon distribution.

      Parameters:
      @@ -1708,7 +1708,7 @@

      Discrete Types
      -sympy.stats.Zeta(name, s)[source]
      +sympy.stats.Zeta(name, s)[source]

      Create a discrete random variable with a Zeta distribution.

      Parameters:
      @@ -1762,7 +1762,7 @@

      Discrete Types

      -sympy.stats.Arcsin(name, a=0, b=1)[source]
      +sympy.stats.Arcsin(name, a=0, b=1)[source]

      Create a Continuous Random Variable with an arcsin distribution.

      The density of the arcsin distribution is given by

      @@ -1813,7 +1813,7 @@

      Continuous Types
      -sympy.stats.Benini(name, alpha, beta, sigma)[source]
      +sympy.stats.Benini(name, alpha, beta, sigma)[source]

      Create a Continuous Random Variable with a Benini distribution.

      The density of the Benini distribution is given by

      @@ -1877,7 +1877,7 @@

      Continuous Types
      -sympy.stats.Beta(name, alpha, beta)[source]
      +sympy.stats.Beta(name, alpha, beta)[source]

      Create a Continuous Random Variable with a Beta distribution.

      The density of the Beta distribution is given by

      @@ -1938,7 +1938,7 @@

      Continuous Types
      -sympy.stats.BetaNoncentral(name, alpha, beta, lamda)[source]
      +sympy.stats.BetaNoncentral(name, alpha, beta, lamda)[source]

      Create a Continuous Random Variable with a Type I Noncentral Beta distribution.

      The density of the Noncentral Beta distribution is given by

      @@ -2009,7 +2009,7 @@

      Continuous Types
      -sympy.stats.BetaPrime(name, alpha, beta)[source]
      +sympy.stats.BetaPrime(name, alpha, beta)[source]

      Create a continuous random variable with a Beta prime distribution.

      The density of the Beta prime distribution is given by

      @@ -2062,7 +2062,7 @@

      Continuous Types
      -sympy.stats.BoundedPareto(name, alpha, left, right)[source]
      +sympy.stats.BoundedPareto(name, alpha, left, right)[source]

      Create a continuous random variable with a Bounded Pareto distribution.

      The density of the Bounded Pareto distribution is given by

      @@ -2113,7 +2113,7 @@

      Continuous Types
      -sympy.stats.Cauchy(name, x0, gamma)[source]
      +sympy.stats.Cauchy(name, x0, gamma)[source]

      Create a continuous random variable with a Cauchy distribution.

      The density of the Cauchy distribution is given by

      @@ -2161,7 +2161,7 @@

      Continuous Types
      -sympy.stats.Chi(name, k)[source]
      +sympy.stats.Chi(name, k)[source]

      Create a continuous random variable with a Chi distribution.

      The density of the Chi distribution is given by

      @@ -2212,7 +2212,7 @@

      Continuous Types
      -sympy.stats.ChiNoncentral(name, k, l)[source]
      +sympy.stats.ChiNoncentral(name, k, l)[source]

      Create a continuous random variable with a non-central Chi distribution.

      Parameters:
      @@ -2266,7 +2266,7 @@

      Continuous Types
      -sympy.stats.ChiSquared(name, k)[source]
      +sympy.stats.ChiSquared(name, k)[source]

      Create a continuous random variable with a Chi-squared distribution.

      Parameters:
      @@ -2330,7 +2330,7 @@

      Continuous Types
      -sympy.stats.Dagum(name, p, a, b)[source]
      +sympy.stats.Dagum(name, p, a, b)[source]

      Create a continuous random variable with a Dagum distribution.

      Parameters:
      @@ -2392,7 +2392,7 @@

      Continuous Types
      -sympy.stats.Davis(name, b, n, mu)[source]
      +sympy.stats.Davis(name, b, n, mu)[source]

      Create a continuous random variable with Davis distribution.

      Parameters:
      @@ -2448,7 +2448,7 @@

      Continuous Types
      -sympy.stats.Erlang(name, k, l)[source]
      +sympy.stats.Erlang(name, k, l)[source]

      Create a continuous random variable with an Erlang distribution.

      Parameters:
      @@ -2519,7 +2519,7 @@

      Continuous Types
      -sympy.stats.ExGaussian(name, mean, std, rate)[source]
      +sympy.stats.ExGaussian(name, mean, std, rate)[source]

      Create a continuous random variable with an Exponentially modified Gaussian (EMG) distribution.

      @@ -2606,7 +2606,7 @@

      Continuous Types
      -sympy.stats.Exponential(name, rate)[source]
      +sympy.stats.Exponential(name, rate)[source]

      Create a continuous random variable with an Exponential distribution.

      Parameters:
      @@ -2689,7 +2689,7 @@

      Continuous Types
      -sympy.stats.FDistribution(name, d1, d2)[source]
      +sympy.stats.FDistribution(name, d1, d2)[source]

      Create a continuous random variable with a F distribution.

      Parameters:
      @@ -2749,7 +2749,7 @@

      Continuous Types
      -sympy.stats.FisherZ(name, d1, d2)[source]
      +sympy.stats.FisherZ(name, d1, d2)[source]

      Create a Continuous Random Variable with an Fisher’s Z distribution.

      Parameters:
      @@ -2814,7 +2814,7 @@

      Continuous Types
      -sympy.stats.Frechet(name, a, s=1, m=0)[source]
      +sympy.stats.Frechet(name, a, s=1, m=0)[source]

      Create a continuous random variable with a Frechet distribution.

      Parameters:
      @@ -2867,7 +2867,7 @@

      Continuous Types
      -sympy.stats.Gamma(name, k, theta)[source]
      +sympy.stats.Gamma(name, k, theta)[source]

      Create a continuous random variable with a Gamma distribution.

      Parameters:
      @@ -2944,7 +2944,7 @@

      Continuous Types
      -sympy.stats.GammaInverse(name, a, b)[source]
      +sympy.stats.GammaInverse(name, a, b)[source]

      Create a continuous random variable with an inverse Gamma distribution.

      Parameters:
      @@ -3001,7 +3001,7 @@

      Continuous Types
      -sympy.stats.Gompertz(name, b, eta)[source]
      +sympy.stats.Gompertz(name, b, eta)[source]

      Create a Continuous Random Variable with Gompertz distribution.

      Parameters:
      @@ -3047,7 +3047,7 @@

      Continuous Types
      -sympy.stats.Gumbel(name, beta, mu, minimum=False)[source]
      +sympy.stats.Gumbel(name, beta, mu, minimum=False)[source]

      Create a Continuous Random Variable with Gumbel distribution.

      Parameters:
      @@ -3110,7 +3110,7 @@

      Continuous Types
      -sympy.stats.Kumaraswamy(name, a, b)[source]
      +sympy.stats.Kumaraswamy(name, a, b)[source]

      Create a Continuous Random Variable with a Kumaraswamy distribution.

      Parameters:
      @@ -3163,7 +3163,7 @@

      Continuous Types
      -sympy.stats.Laplace(name, mu, b)[source]
      +sympy.stats.Laplace(name, mu, b)[source]

      Create a continuous random variable with a Laplace distribution.

      Parameters:
      @@ -3230,7 +3230,7 @@

      Continuous Types
      -sympy.stats.Levy(name, mu, c)[source]
      +sympy.stats.Levy(name, mu, c)[source]

      Create a continuous random variable with a Levy distribution.

      The density of the Levy distribution is given by

      @@ -3288,7 +3288,7 @@

      Continuous Types
      -sympy.stats.Logistic(name, mu, s)[source]
      +sympy.stats.Logistic(name, mu, s)[source]

      Create a continuous random variable with a logistic distribution.

      Parameters:
      @@ -3341,7 +3341,7 @@

      Continuous Types
      -sympy.stats.LogLogistic(name, alpha, beta)[source]
      +sympy.stats.LogLogistic(name, alpha, beta)[source]

      Create a continuous random variable with a log-logistic distribution. The distribution is unimodal when beta > 1.

      @@ -3407,7 +3407,7 @@

      Continuous Types
      -sympy.stats.LogNormal(name, mean, std)[source]
      +sympy.stats.LogNormal(name, mean, std)[source]

      Create a continuous random variable with a log-normal distribution.

      Parameters:
      @@ -3480,7 +3480,7 @@

      Continuous Types
      -sympy.stats.Lomax(name, alpha, lamda)[source]
      +sympy.stats.Lomax(name, alpha, lamda)[source]

      Create a continuous random variable with a Lomax distribution.

      Parameters:
      @@ -3530,7 +3530,7 @@

      Continuous Types
      -sympy.stats.Maxwell(name, a)[source]
      +sympy.stats.Maxwell(name, a)[source]

      Create a continuous random variable with a Maxwell distribution.

      Parameters:
      @@ -3586,7 +3586,7 @@

      Continuous Types
      -sympy.stats.Moyal(name, mu, sigma)[source]
      +sympy.stats.Moyal(name, mu, sigma)[source]

      Create a continuous random variable with a Moyal distribution.

      Parameters:
      @@ -3638,7 +3638,7 @@

      Continuous Types
      -sympy.stats.Nakagami(name, mu, omega)[source]
      +sympy.stats.Nakagami(name, mu, omega)[source]

      Create a continuous random variable with a Nakagami distribution.

      Parameters:
      @@ -3709,7 +3709,7 @@

      Continuous Types
      -sympy.stats.Normal(name, mean, std)[source]
      +sympy.stats.Normal(name, mean, std)[source]

      Create a continuous random variable with a Normal distribution.

      Parameters:
      @@ -3807,7 +3807,7 @@

      Continuous Types
      -sympy.stats.Pareto(name, xm, alpha)[source]
      +sympy.stats.Pareto(name, xm, alpha)[source]

      Create a continuous random variable with the Pareto distribution.

      Parameters:
      @@ -3857,7 +3857,7 @@

      Continuous Types
      -sympy.stats.PowerFunction(name, alpha, a, b)[source]
      +sympy.stats.PowerFunction(name, alpha, a, b)[source]

      Creates a continuous random variable with a Power Function Distribution.

      Parameters:
      @@ -3922,7 +3922,7 @@

      Continuous Types
      -sympy.stats.QuadraticU(name, a, b)[source]
      +sympy.stats.QuadraticU(name, a, b)[source]

      Create a Continuous Random Variable with a U-quadratic distribution.

      Parameters:
      @@ -3977,7 +3977,7 @@

      Continuous Types
      -sympy.stats.RaisedCosine(name, mu, s)[source]
      +sympy.stats.RaisedCosine(name, mu, s)[source]

      Create a Continuous Random Variable with a raised cosine distribution.

      Parameters:
      @@ -4030,7 +4030,7 @@

      Continuous Types
      -sympy.stats.Rayleigh(name, sigma)[source]
      +sympy.stats.Rayleigh(name, sigma)[source]

      Create a continuous random variable with a Rayleigh distribution.

      Parameters:
      @@ -4086,7 +4086,7 @@

      Continuous Types
      -sympy.stats.Reciprocal(name, a, b)[source]
      +sympy.stats.Reciprocal(name, a, b)[source]

      Creates a continuous random variable with a reciprocal distribution.

      Parameters:
      @@ -4121,7 +4121,7 @@

      Continuous Types
      -sympy.stats.StudentT(name, nu)[source]
      +sympy.stats.StudentT(name, nu)[source]

      Create a continuous random variable with a student’s t distribution.

      Parameters:
      @@ -4186,7 +4186,7 @@

      Continuous Types
      -sympy.stats.ShiftedGompertz(name, b, eta)[source]
      +sympy.stats.ShiftedGompertz(name, b, eta)[source]

      Create a continuous random variable with a Shifted Gompertz distribution.

      Parameters:
      @@ -4232,7 +4232,7 @@

      Continuous Types
      -sympy.stats.Trapezoidal(name, a, b, c, d)[source]
      +sympy.stats.Trapezoidal(name, a, b, c, d)[source]

      Create a continuous random variable with a trapezoidal distribution.

      Parameters:
      @@ -4299,7 +4299,7 @@

      Continuous Types
      -sympy.stats.Triangular(name, a, b, c)[source]
      +sympy.stats.Triangular(name, a, b, c)[source]

      Create a continuous random variable with a triangular distribution.

      Parameters:
      @@ -4368,7 +4368,7 @@

      Continuous Types
      -sympy.stats.Uniform(name, left, right)[source]
      +sympy.stats.Uniform(name, left, right)[source]

      Create a continuous random variable with a uniform distribution.

      Parameters:
      @@ -4433,7 +4433,7 @@

      Continuous Types
      -sympy.stats.UniformSum(name, n)[source]
      +sympy.stats.UniformSum(name, n)[source]

      Create a continuous random variable with an Irwin-Hall distribution.

      Parameters:
      @@ -4503,7 +4503,7 @@

      Continuous Types
      -sympy.stats.VonMises(name, mu, k)[source]
      +sympy.stats.VonMises(name, mu, k)[source]

      Create a Continuous Random Variable with a von Mises distribution.

      Parameters:
      @@ -4563,7 +4563,7 @@

      Continuous Types
      -sympy.stats.Wald(name, mean, shape)[source]
      +sympy.stats.Wald(name, mean, shape)[source]

      Create a continuous random variable with an Inverse Gaussian distribution. Inverse Gaussian distribution is also known as Wald distribution.

      @@ -4638,7 +4638,7 @@

      Continuous Types
      -sympy.stats.Weibull(name, alpha, beta)[source]
      +sympy.stats.Weibull(name, alpha, beta)[source]

      Create a continuous random variable with a Weibull distribution.

      Parameters:
      @@ -4699,7 +4699,7 @@

      Continuous Types
      -sympy.stats.WignerSemicircle(name, R)[source]
      +sympy.stats.WignerSemicircle(name, R)[source]

      Create a continuous random variable with a Wigner semicircle distribution.

      Parameters:
      @@ -4760,7 +4760,7 @@

      Continuous Types**kwargs,

      -)[source] +)[source]

      Create a Continuous Random Variable given the following:

      Parameters:
      @@ -4814,7 +4814,7 @@

      Continuous Types

      -sympy.stats.JointRV(symbol, pdf, _set=None)[source]
      +sympy.stats.JointRV(symbol, pdf, _set=None)[source]

      Create a Joint Random Variable where each of its component is continuous, given the following:

      @@ -4849,7 +4849,7 @@

      Joint Types
      -sympy.stats.marginal_distribution(rv, *indices)[source]
      +sympy.stats.marginal_distribution(rv, *indices)[source]

      Marginal distribution function of a joint random variable.

      Parameters:
      @@ -4874,7 +4874,7 @@

      Joint Types
      -sympy.stats.MultivariateNormal(name, mu, sigma)[source]
      +sympy.stats.MultivariateNormal(name, mu, sigma)[source]

      Creates a continuous random variable with Multivariate Normal Distribution.

      The density of the multivariate normal distribution can be found at [1].

      @@ -4932,7 +4932,7 @@

      Joint Types
      -sympy.stats.MultivariateLaplace(name, mu, sigma)[source]
      +sympy.stats.MultivariateLaplace(name, mu, sigma)[source]

      Creates a continuous random variable with Multivariate Laplace Distribution.

      The density of the multivariate Laplace distribution can be found at [1].

      @@ -4980,7 +4980,7 @@

      Joint Typesmu,

      -)[source] +)[source]

      Creates a joint random variable with generalized multivariate log gamma distribution.

      The joint pdf can be found at [1].

      @@ -5043,7 +5043,7 @@

      Joint Typesmu,

      -)[source] +)[source]

      Extends GeneralizedMultivariateLogGamma.

      Parameters:
      @@ -5099,7 +5099,7 @@

      Joint Types
      -sympy.stats.Multinomial(syms, n, *p)[source]
      +sympy.stats.Multinomial(syms, n, *p)[source]

      Creates a discrete random variable with Multinomial Distribution.

      The density of the said distribution can be found at [1].

      @@ -5145,7 +5145,7 @@

      Joint Types
      -sympy.stats.MultivariateBeta(syms, *alpha)[source]
      +sympy.stats.MultivariateBeta(syms, *alpha)[source]

      Creates a continuous random variable with Dirichlet/Multivariate Beta Distribution.

      The density of the Dirichlet distribution can be found at [1].

      @@ -5190,7 +5190,7 @@

      Joint Types
      -sympy.stats.MultivariateEwens(syms, n, theta)[source]
      +sympy.stats.MultivariateEwens(syms, n, theta)[source]

      Creates a discrete random variable with Multivariate Ewens Distribution.

      The density of the said distribution can be found at [1].

      @@ -5236,7 +5236,7 @@

      Joint Types
      -sympy.stats.MultivariateT(syms, mu, sigma, v)[source]
      +sympy.stats.MultivariateT(syms, mu, sigma, v)[source]

      Creates a joint random variable with multivariate T-distribution.

      Parameters:
      @@ -5271,7 +5271,7 @@

      Joint Types
      -sympy.stats.NegativeMultinomial(syms, k0, *p)[source]
      +sympy.stats.NegativeMultinomial(syms, k0, *p)[source]

      Creates a discrete random variable with Negative Multinomial Distribution.

      The density of the said distribution can be found at [1].

      @@ -5318,7 +5318,7 @@

      Joint Types
      -sympy.stats.NormalGamma(sym, mu, lamda, alpha, beta)[source]
      +sympy.stats.NormalGamma(sym, mu, lamda, alpha, beta)[source]

      Creates a bivariate joint random variable with multivariate Normal gamma distribution.

      @@ -5383,7 +5383,7 @@

      Joint Typestrans_probs=None,

      -)[source] +)[source]

      Represents a finite discrete time-homogeneous Markov chain.

      This type of Markov Chain can be uniquely characterised by its (ordered) state space and its one-step transition probability @@ -5510,7 +5510,7 @@

      Joint Types
      -absorbing_probabilities()[source]
      +absorbing_probabilities()[source]

      Computes the absorbing probabilities, i.e. the ij-th entry of the matrix denotes the probability of Markov chain being absorbed @@ -5519,7 +5519,7 @@

      Joint Types
      -canonical_form() Tuple[List[Basic], ImmutableDenseMatrix][source]
      +canonical_form() Tuple[List[Basic], ImmutableDenseMatrix][source]

      Reorders the one-step transition matrix so that recurrent states appear first and transient states appear last. Other representations include inserting @@ -5621,7 +5621,7 @@

      Joint Types
      -communication_classes() List[Tuple[List[Basic], Boolean, Integer]][source]
      +communication_classes() List[Tuple[List[Basic], Boolean, Integer]][source]

      Returns the list of communication classes that partition the states of the markov chain.

      A communication class is defined to be a set of states @@ -5693,7 +5693,7 @@

      Joint Types
      -decompose() Tuple[List[Basic], ImmutableDenseMatrix, ImmutableDenseMatrix, ImmutableDenseMatrix][source]
      +decompose() Tuple[List[Basic], ImmutableDenseMatrix, ImmutableDenseMatrix, ImmutableDenseMatrix][source]

      Decomposes the transition matrix into submatrices with special properties.

      The transition matrix can be decomposed into 4 submatrices: @@ -5776,13 +5776,13 @@

      Joint Types
      -fixed_row_vector()[source]
      +fixed_row_vector()[source]

      A wrapper for stationary_distribution().

      -fundamental_matrix()[source]
      +fundamental_matrix()[source]

      Each entry fundamental matrix can be interpreted as the expected number of times the chains is in state j if it started in state i.

      @@ -5804,7 +5804,7 @@

      Joint Types
      -sample()[source]
      +sample()[source]
      Returns:

      sample: iterator object

      @@ -5823,7 +5823,7 @@

      Joint Typescondition_set=False,

      -) ImmutableDenseMatrix | ConditionSet | Lambda[source] +) ImmutableDenseMatrix | ConditionSet | Lambda[source]

      The stationary distribution is any row vector, p, that solves p = pP, is row stochastic and each element in p must be nonnegative. That means in matrix form: \((P-I)^T p^T = 0\) and @@ -5911,7 +5911,7 @@

      Joint Typesgen_mat=None,

      -)[source] +)[source]

      Represents continuous time Markov chain.

      Parameters:
      @@ -5996,7 +5996,7 @@

      Joint Types
      -class sympy.stats.BernoulliProcess(sym, p, success=1, failure=0)[source]
      +class sympy.stats.BernoulliProcess(sym, p, success=1, failure=0)[source]

      The Bernoulli process consists of repeated independent Bernoulli process trials with the same parameter \(p\). It’s assumed that the probability \(p\) applies to every @@ -6075,7 +6075,7 @@

      Joint Types**kwargs,

      -)[source] +)[source]

      Computes expectation.

      Parameters:
      @@ -6106,7 +6106,7 @@

      Joint Types**kwargs,

      -)[source] +)[source]

      Computes probability.

      Parameters:
      @@ -6130,7 +6130,7 @@

      Joint Types
      -class sympy.stats.PoissonProcess(sym, lamda)[source]
      +class sympy.stats.PoissonProcess(sym, lamda)[source]

      The Poisson process is a counting process. It is usually used in scenarios where we are counting the occurrences of certain events that appear to happen at a certain rate, but completely at random.

      @@ -6200,7 +6200,7 @@

      Joint Types
      -class sympy.stats.WienerProcess(sym)[source]
      +class sympy.stats.WienerProcess(sym)[source]

      The Wiener process is a real valued continuous-time stochastic process. In physics it is used to study Brownian motion and it is often also called Brownian motion due to its historical connection with physical process of the @@ -6243,7 +6243,7 @@

      Joint Types
      -class sympy.stats.GammaProcess(sym, lamda, gamma)[source]
      +class sympy.stats.GammaProcess(sym, lamda, gamma)[source]

      A Gamma process is a random process with independent gamma distributed increments. It is a pure-jump increasing Levy process.

      @@ -6292,7 +6292,7 @@

      Joint Types

      -sympy.stats.MatrixGamma(symbol, alpha, beta, scale_matrix)[source]
      +sympy.stats.MatrixGamma(symbol, alpha, beta, scale_matrix)[source]

      Creates a random variable with Matrix Gamma Distribution.

      The density of the said distribution can be found at [1].

      @@ -6339,7 +6339,7 @@

      Matrix Distributions
      -sympy.stats.Wishart(symbol, n, scale_matrix)[source]
      +sympy.stats.Wishart(symbol, n, scale_matrix)[source]

      Creates a random variable with Wishart Distribution.

      The density of the said distribution can be found at [1].

      @@ -6391,7 +6391,7 @@

      Matrix Distributionsscale_matrix_2,

      -)[source] +)[source]

      Creates a random variable with Matrix Normal Distribution.

      The density of the said distribution can be found at [1].

      @@ -6440,7 +6440,7 @@

      Matrix DistributionsCompound Distribution

      -class sympy.stats.compound_rv.CompoundDistribution(dist)[source]
      +class sympy.stats.compound_rv.CompoundDistribution(dist)[source]

      Class for Compound Distributions.

      Parameters:
      @@ -6489,7 +6489,7 @@

      Interface**kwargs,

      -)[source] +)[source]

      Probability that a condition is true, optionally given a second condition.

      Parameters:
      @@ -6528,7 +6528,7 @@

      Interface
      -class sympy.stats.Probability(prob, condition=None, **kwargs)[source]
      +class sympy.stats.Probability(prob, condition=None, **kwargs)[source]

      Symbolic expression for the probability.

      Examples

      >>> from sympy.stats import Probability, Normal
      @@ -6563,7 +6563,7 @@ 

      Interface**kwargs,

      -)[source] +)[source]

      Returns the expected value of a random expression.

      Parameters:
      @@ -6606,7 +6606,7 @@

      Interface
      -class sympy.stats.Expectation(expr, condition=None, **kwargs)[source]
      +class sympy.stats.Expectation(expr, condition=None, **kwargs)[source]

      Symbolic expression for the expectation.

      Examples

      >>> from sympy.stats import Expectation, Normal, Probability, Poisson
      @@ -6685,7 +6685,7 @@ 

      Interface**kwargs,

      -)[source] +)[source]

      Probability density of a random expression, optionally given a second condition.

      @@ -6731,7 +6731,7 @@

      Interface
      -sympy.stats.entropy(expr, condition=None, **kwargs)[source]
      +sympy.stats.entropy(expr, condition=None, **kwargs)[source]

      Calculuates entropy of a probability distribution.

      Parameters:
      @@ -6777,7 +6777,7 @@

      Interface
      -sympy.stats.given(expr, condition=None, **kwargs)[source]
      +sympy.stats.given(expr, condition=None, **kwargs)[source]

      Conditional Random Expression.

      Explanation

      From a random expression and a condition on that expression creates a new @@ -6815,7 +6815,7 @@

      Interface
      -sympy.stats.where(condition, given_condition=None, **kwargs)[source]
      +sympy.stats.where(condition, given_condition=None, **kwargs)[source]

      Returns the domain where a condition is True.

      Examples

      >>> from sympy.stats import where, Die, Normal
      @@ -6843,7 +6843,7 @@ 

      Interface
      -sympy.stats.variance(X, condition=None, **kwargs)[source]
      +sympy.stats.variance(X, condition=None, **kwargs)[source]

      Variance of a random expression.

      @@ -6871,7 +6871,7 @@

      Interface
      -class sympy.stats.Variance(arg, condition=None, **kwargs)[source]
      +class sympy.stats.Variance(arg, condition=None, **kwargs)[source]

      Symbolic expression for the variance.

      Examples

      >>> from sympy import symbols, Integral
      @@ -6920,7 +6920,7 @@ 

      Interface
      -sympy.stats.covariance(X, Y, condition=None, **kwargs)[source]
      +sympy.stats.covariance(X, Y, condition=None, **kwargs)[source]

      Covariance of two random expressions.

      Explanation

      The expectation that the two variables will rise and fall together

      @@ -6950,7 +6950,7 @@

      Interface
      -class sympy.stats.Covariance(arg1, arg2, condition=None, **kwargs)[source]
      +class sympy.stats.Covariance(arg1, arg2, condition=None, **kwargs)[source]

      Symbolic expression for the covariance.

      Examples

      >>> from sympy.stats import Covariance
      @@ -6995,7 +6995,7 @@ 

      Interface
      -sympy.stats.coskewness(X, Y, Z, condition=None, **kwargs)[source]
      +sympy.stats.coskewness(X, Y, Z, condition=None, **kwargs)[source]

      Calculates the co-skewness of three random variables.

      Parameters:
      @@ -7055,7 +7055,7 @@

      Interface
      -sympy.stats.median(X, evaluate=True, **kwargs)[source]
      +sympy.stats.median(X, evaluate=True, **kwargs)[source]

      Calculuates the median of the probability distribution.

      Parameters:
      @@ -7094,7 +7094,7 @@

      Interface
      -sympy.stats.std(X, condition=None, **kwargs)[source]
      +sympy.stats.std(X, condition=None, **kwargs)[source]

      Standard Deviation of a random expression

      @@ -7117,7 +7117,7 @@

      Interface
      -sympy.stats.quantile(expr, evaluate=True, **kwargs)[source]
      +sympy.stats.quantile(expr, evaluate=True, **kwargs)[source]

      Return the \(p^{th}\) order quantile of a probability distribution.

      Explanation

      Quantile is defined as the value at which the probability of the random @@ -7171,7 +7171,7 @@

      Interface**kwargs,

      -)[source] +)[source]

      A realization of the random expression.

      Parameters:
      @@ -7292,7 +7292,7 @@

      Interface**kwargs,

      -)[source] +)[source]

      Returns an iterator of realizations from the expression given a condition.

      Parameters:
      @@ -7351,7 +7351,7 @@

      Interface
      -sympy.stats.factorial_moment(X, n, condition=None, **kwargs)[source]
      +sympy.stats.factorial_moment(X, n, condition=None, **kwargs)[source]

      The factorial moment is a mathematical quantity defined as the expectation or average of the falling factorial of a random variable.

      @@ -7396,7 +7396,7 @@

      Interface
      -sympy.stats.kurtosis(X, condition=None, **kwargs)[source]
      +sympy.stats.kurtosis(X, condition=None, **kwargs)[source]

      Characterizes the tails/outliers of a probability distribution.

      Parameters:
      @@ -7445,7 +7445,7 @@

      Interface
      -sympy.stats.skewness(X, condition=None, **kwargs)[source]
      +sympy.stats.skewness(X, condition=None, **kwargs)[source]

      Measure of the asymmetry of the probability distribution.

      Parameters:
      @@ -7482,7 +7482,7 @@

      Interface
      -sympy.stats.correlation(X, Y, condition=None, **kwargs)[source]
      +sympy.stats.correlation(X, Y, condition=None, **kwargs)[source]

      Correlation of two random expressions, also known as correlation coefficient or Pearson’s correlation.

      Explanation

      @@ -7525,7 +7525,7 @@

      Interface**kwargs,

      -)[source] +)[source]

      Sampling version of density.

      See also

      @@ -7547,7 +7547,7 @@

      Interface**kwargs,

      -)[source] +)[source]

      Sampling version of P.

      See also

      @@ -7569,7 +7569,7 @@

      Interface**kwargs,

      -)[source] +)[source]

      Sampling version of E.

      See also

      @@ -7579,7 +7579,7 @@

      Interface
      -class sympy.stats.Moment(X, n, c=0, condition=None, **kwargs)[source]
      +class sympy.stats.Moment(X, n, c=0, condition=None, **kwargs)[source]

      Symbolic class for Moment

      Examples

      >>> from sympy import Symbol, Integral
      @@ -7626,7 +7626,7 @@ 

      Interface**kwargs,

      -)[source] +)[source]

      Return the nth moment of a random expression about c.

      @@ -7648,7 +7648,7 @@

      Interface
      -class sympy.stats.CentralMoment(X, n, condition=None, **kwargs)[source]
      +class sympy.stats.CentralMoment(X, n, condition=None, **kwargs)[source]

      Symbolic class Central Moment

      Examples

      >>> from sympy import Symbol, Integral
      @@ -7694,7 +7694,7 @@ 

      Interface**kwargs,

      -)[source] +)[source]

      Return the nth central moment of a random expression about its mean.

      @@ -7715,7 +7715,7 @@

      Interface
      -class sympy.stats.ExpectationMatrix(expr, condition=None)[source]
      +class sympy.stats.ExpectationMatrix(expr, condition=None)[source]

      Expectation of a random matrix expression.

      Examples

      >>> from sympy.stats import ExpectationMatrix, Normal
      @@ -7754,7 +7754,7 @@ 

      Interface
      -class sympy.stats.VarianceMatrix(arg, condition=None)[source]
      +class sympy.stats.VarianceMatrix(arg, condition=None)[source]

      Variance of a random matrix probability expression. Also known as Covariance matrix, auto-covariance matrix, dispersion matrix, or variance-covariance matrix.

      @@ -7782,7 +7782,7 @@

      Interface
      -class sympy.stats.CrossCovarianceMatrix(arg1, arg2, condition=None)[source]
      +class sympy.stats.CrossCovarianceMatrix(arg1, arg2, condition=None)[source]

      Covariance of a random matrix probability expression.

      Examples

      >>> from sympy.stats import CrossCovarianceMatrix
      @@ -7821,7 +7821,7 @@ 

      Interface\(\{1,2,3,4,5,6\}\).

      -class sympy.stats.rv.RandomDomain[source]
      +class sympy.stats.rv.RandomDomain[source]

      A PSpace, or Probability Space, combines a RandomDomain @@ -7831,13 +7831,13 @@

      Interfacex.

      -class sympy.stats.rv.PSpace[source]
      +class sympy.stats.rv.PSpace[source]

      A RandomSymbol represents the PSpace’s symbol ‘x’ inside of SymPy expressions.

      -class sympy.stats.rv.RandomSymbol[source]
      +class sympy.stats.rv.RandomSymbol[source]

      The RandomDomain and PSpace classes are almost never directly instantiated. @@ -7849,12 +7849,12 @@

      Interface
      -class sympy.stats.rv.SinglePSpace[source]
      +class sympy.stats.rv.SinglePSpace[source]

      -class sympy.stats.rv.SingleDomain[source]
      +class sympy.stats.rv.SingleDomain[source]

      Another common case is to collect together a set of such univariate random @@ -7863,12 +7863,12 @@

      Interface
      -class sympy.stats.rv.ProductDomain[source]
      +class sympy.stats.rv.ProductDomain[source]

      -class sympy.stats.rv.ProductPSpace[source]
      +class sympy.stats.rv.ProductPSpace[source]

      The Conditional adjective is added whenever we add a global condition to a @@ -7876,7 +7876,7 @@

      Interface
      -class sympy.stats.rv.ConditionalDomain[source]
      +class sympy.stats.rv.ConditionalDomain[source]

      We specialize further into Finite and Continuous versions of these classes to @@ -7884,22 +7884,22 @@

      Interface
      -class sympy.stats.frv.FiniteDomain[source]
      +class sympy.stats.frv.FiniteDomain[source]

      -class sympy.stats.frv.FinitePSpace[source]
      +class sympy.stats.frv.FinitePSpace[source]
      -class sympy.stats.crv.ContinuousDomain[source]
      +class sympy.stats.crv.ContinuousDomain[source]
      -class sympy.stats.crv.ContinuousPSpace[source]
      +class sympy.stats.crv.ContinuousPSpace[source]

      Additionally there are a few specialized classes that implement certain common @@ -7943,13 +7943,13 @@

      Interface
      -sympy.stats.rv.random_symbols(expr)[source]
      +sympy.stats.rv.random_symbols(expr)[source]

      Returns all RandomSymbols within a SymPy Expression.

      -sympy.stats.rv.pspace(expr)[source]
      +sympy.stats.rv.pspace(expr)[source]

      Returns the underlying Probability Space of a random expression.

      For internal use.

      Examples

      @@ -7963,7 +7963,7 @@

      Interface
      -sympy.stats.rv.rs_swap(a, b)[source]
      +sympy.stats.rv.rs_swap(a, b)[source]

      Build a dictionary to swap RandomSymbols based on their underlying symbol.

      i.e. if X = ('x', pspace1) diff --git a/dev/modules/tensor/array.html b/dev/modules/tensor/array.html index 6ebaa2dea14..48d811285f0 100644 --- a/dev/modules/tensor/array.html +++ b/dev/modules/tensor/array.html @@ -1045,7 +1045,7 @@

      Classes
      **kwargs,

      -)[source] +)[source]
      @@ -1058,7 +1058,7 @@

      Classes
      **kwargs,

      -)[source] +)[source]
      @@ -1071,7 +1071,7 @@

      Classes
      **kwargs,

      -)[source] +)[source]

      @@ -1084,7 +1084,7 @@

      Classes
      **kwargs,

      -)[source] +)[source]

      @@ -1092,7 +1092,7 @@

      Classes

      Functions

      -sympy.tensor.array.derive_by_array(expr, dx)[source]
      +sympy.tensor.array.derive_by_array(expr, dx)[source]

      Derivative by arrays. Supports both arrays and scalars.

      The equivalent operator for array expressions is array_derive.

      Explanation

      @@ -1124,7 +1124,7 @@

      Functionsindex_order_new=None,

      -)[source] +)[source]

      Permutes the indices of an array.

      Parameter specifies the permutation of the indices.

      The equivalent operator for array expressions is PermuteDims, which can @@ -1177,7 +1177,7 @@

      Functions
      -sympy.tensor.array.tensorcontraction(array, *contraction_axes)[source]
      +sympy.tensor.array.tensorcontraction(array, *contraction_axes)[source]

      Contraction of an array-like object on the specified axes.

      The equivalent operator for array expressions is ArrayContraction, which can be used to keep the expression unevaluated.

      @@ -1218,7 +1218,7 @@

      Functions
      -sympy.tensor.array.tensorproduct(*args)[source]
      +sympy.tensor.array.tensorproduct(*args)[source]

      Tensor product among scalars or array-like objects.

      The equivalent operator for array expressions is ArrayTensorProduct, which can be used to keep the expression unevaluated.

      @@ -1251,7 +1251,7 @@

      Functions
      -sympy.tensor.array.tensordiagonal(array, *diagonal_axes)[source]
      +sympy.tensor.array.tensordiagonal(array, *diagonal_axes)[source]

      Diagonalization of an array-like object on the specified axes.

      This is equivalent to multiplying the expression by Kronecker deltas uniting the axes.

      diff --git a/dev/modules/tensor/array_expressions.html b/dev/modules/tensor/array_expressions.html index de12788e981..9aa7e4e0f66 100644 --- a/dev/modules/tensor/array_expressions.html +++ b/dev/modules/tensor/array_expressions.html @@ -968,7 +968,7 @@

      Compatibility with matrices
      -class sympy.tensor.array.expressions.ArrayTensorProduct(*args, **kwargs)[source]
      +class sympy.tensor.array.expressions.ArrayTensorProduct(*args, **kwargs)[source]

      Class to represent the tensor product of array-like objects.

      @@ -982,14 +982,14 @@

      Compatibility with matrices**kwargs,

      -)[source] +)[source]

      This class is meant to represent contractions of arrays in a form easily processable by the code printers.

      -class sympy.tensor.array.expressions.ArrayDiagonal(expr, *diagonal_indices, **kwargs)[source]
      +class sympy.tensor.array.expressions.ArrayDiagonal(expr, *diagonal_indices, **kwargs)[source]

      Class to represent the diagonal operator.

      Explanation

      In a 2-dimensional array it returns the diagonal, this looks like the @@ -1018,7 +1018,7 @@

      Compatibility with matrices**kwargs,

      -)[source] +)[source]

      Class to represent permutation of axes of arrays.

      Examples

      >>> from sympy.tensor.array import permutedims
      diff --git a/dev/modules/tensor/index_methods.html b/dev/modules/tensor/index_methods.html
      index 91b0e18ce73..dff30d1f0ab 100644
      --- a/dev/modules/tensor/index_methods.html
      +++ b/dev/modules/tensor/index_methods.html
      @@ -814,7 +814,7 @@ 
      Documentation Version
      refactoring.

      -sympy.tensor.index_methods.get_contraction_structure(expr)[source]
      +sympy.tensor.index_methods.get_contraction_structure(expr)[source]

      Determine dummy indices of expr and describe its structure

      By dummy we mean indices that are summation indices.

      The structure of the expression is determined and described as follows:

      @@ -914,7 +914,7 @@
      Documentation Version
      -sympy.tensor.index_methods.get_indices(expr)[source]
      +sympy.tensor.index_methods.get_indices(expr)[source]

      Determine the outer indices of expression expr

      By outer we mean indices that are not summation indices. Returns a set and a dict. The set contains outer indices and the dict contains diff --git a/dev/modules/tensor/indexed.html b/dev/modules/tensor/indexed.html index f558daed664..6d798004f0f 100644 --- a/dev/modules/tensor/indexed.html +++ b/dev/modules/tensor/indexed.html @@ -888,7 +888,7 @@

      Examples
      -class sympy.tensor.indexed.Idx(label, range=None, **kw_args)[source]
      +class sympy.tensor.indexed.Idx(label, range=None, **kw_args)[source]

      Represents an integer index as an Integer or integer expression.

      There are a number of ways to create an Idx object. The constructor takes two arguments:

      @@ -994,7 +994,7 @@

      Examples
      -class sympy.tensor.indexed.Indexed(base, *args, **kw_args)[source]
      +class sympy.tensor.indexed.Indexed(base, *args, **kw_args)[source]

      Represents a mathematical object with indices.

      >>> from sympy import Indexed, IndexedBase, Idx, symbols
       >>> i, j = symbols('i j', cls=Idx)
      @@ -1113,7 +1113,7 @@ 

      Examples
      **kw_args,

      -)[source] +)[source]

      Represent the base or stem of an indexed object

      The IndexedBase class represent an array that contains elements. The main purpose of this class is to allow the convenient creation of objects of the Indexed diff --git a/dev/modules/tensor/tensor.html b/dev/modules/tensor/tensor.html index 093363abc36..c518751e21f 100644 --- a/dev/modules/tensor/tensor.html +++ b/dev/modules/tensor/tensor.html @@ -817,7 +817,7 @@

      Documentation Version
      **kwargs,

      -)[source] +)[source]

      A TensorIndexType is characterized by its name and its metric.

      Parameters:
      @@ -886,7 +886,7 @@
      Documentation Version
      -class sympy.tensor.tensor.TensorIndex(name, tensor_index_type, is_up=True)[source]
      +class sympy.tensor.tensor.TensorIndex(name, tensor_index_type, is_up=True)[source]

      Represents a tensor index

      Parameters:
      @@ -948,7 +948,7 @@
      Documentation Version
      comm=0,
      -)[source] +)[source]

      Tensor head of the tensor.

      Parameters:
      @@ -1067,7 +1067,7 @@
      Documentation Version

      -commutes_with(other)[source]
      +commutes_with(other)[source]

      Returns 0 if self and other commute, 1 if they anticommute.

      Returns None if self and other neither commute nor anticommute.

      @@ -1085,13 +1085,13 @@
      Documentation Version
      comm=0,

      -)[source] +)[source]

      Returns a sequence of TensorHeads from a string \(s\)

      -class sympy.tensor.tensor.TensExpr(*args)[source]
      +class sympy.tensor.tensor.TensExpr(*args)[source]

      Abstract base class for tensor expressions

      Notes

      A tensor expression is an expression formed by tensors; @@ -1106,7 +1106,7 @@

      Documentation Version

      Contracted indices are therefore nameless in the internal representation.

      -get_matrix()[source]
      +get_matrix()[source]

      DEPRECATED: do not use.

      Returns ndarray components data as a matrix, if components data are available and ndarray dimension does not exceed 2.

      @@ -1121,7 +1121,7 @@
      Documentation Version
      indices=None,
      -)[source] +)[source]

      Replace the tensorial expressions with arrays. The final array will correspond to the N-dimensional array with indices arranged according to indices.

      @@ -1196,7 +1196,7 @@
      Documentation Version
      -class sympy.tensor.tensor.TensAdd(*args, **kw_args)[source]
      +class sympy.tensor.tensor.TensAdd(*args, **kw_args)[source]

      Sum of tensors.

      Parameters:
      @@ -1245,14 +1245,14 @@
      Documentation Version

      -canon_bp()[source]
      +canon_bp()[source]

      Canonicalize using the Butler-Portugal algorithm for canonicalization under monoterm symmetries.

      -contract_metric(g)[source]
      +contract_metric(g)[source]

      Raise or lower indices with the metric g.

      Parameters:
      @@ -1268,7 +1268,7 @@
      Documentation Version
      -class sympy.tensor.tensor.TensMul(*args, **kw_args)[source]
      +class sympy.tensor.tensor.TensMul(*args, **kw_args)[source]

      Product of tensors.

      Parameters:
      @@ -1322,7 +1322,7 @@
      Documentation Version

      -canon_bp()[source]
      +canon_bp()[source]

      Canonicalize using the Butler-Portugal algorithm for canonicalization under monoterm symmetries.

      Examples

      @@ -1342,7 +1342,7 @@
      Documentation Version
      -contract_metric(g)[source]
      +contract_metric(g)[source]

      Raise or lower indices with the metric g.

      Parameters:
      @@ -1368,7 +1368,7 @@
      Documentation Version
      -get_free_indices() list[TensorIndex][source]
      +get_free_indices() list[TensorIndex][source]

      Returns the list of free indices of the tensor.

      Explanation

      The indices are listed in the order in which they appear in the @@ -1391,7 +1391,7 @@

      Documentation Version
      -get_indices()[source]
      +get_indices()[source]

      Returns the list of indices of the tensor.

      Explanation

      The indices are listed in the order in which they appear in the @@ -1416,20 +1416,20 @@

      Documentation Version
      -perm2tensor(g, is_canon_bp=False)[source]
      +perm2tensor(g, is_canon_bp=False)[source]

      Returns the tensor corresponding to the permutation g

      For further details, see the method in TIDS with the same name.

      -sorted_components()[source]
      +sorted_components()[source]

      Returns a tensor product with sorted components.

      -split()[source]
      +split()[source]

      Returns a list of tensors, whose product is self.

      Explanation

      Dummy indices contracted among different tensor components @@ -1453,21 +1453,21 @@

      Documentation Version
      -sympy.tensor.tensor.canon_bp(p)[source]
      +sympy.tensor.tensor.canon_bp(p)[source]

      Butler-Portugal canonicalization. See tensor_can.py from the combinatorics module for the details.

      -sympy.tensor.tensor.riemann_cyclic_replace(t_r)[source]
      +sympy.tensor.tensor.riemann_cyclic_replace(t_r)[source]

      replace Riemann tensor with an equivalent expression

      R(m,n,p,q) -> 2/3*R(m,n,p,q) - 1/3*R(m,q,n,p) + 1/3*R(m,p,n,q)

      -sympy.tensor.tensor.riemann_cyclic(t2)[source]
      +sympy.tensor.tensor.riemann_cyclic(t2)[source]

      Replace each Riemann tensor with an equivalent expression satisfying the cyclic identity.

      This trick is discussed in the reference guide to Cadabra.

      @@ -1485,7 +1485,7 @@
      Documentation Version
      -class sympy.tensor.tensor.TensorSymmetry(*args, **kw_args)[source]
      +class sympy.tensor.tensor.TensorSymmetry(*args, **kw_args)[source]

      Monoterm symmetry of a tensor (i.e. any symmetric or anti-symmetric index permutation). For the relevant terminology see tensor_can.py section of the combinatorics module.

      @@ -1536,7 +1536,7 @@
      Documentation Version

      -classmethod direct_product(*args)[source]
      +classmethod direct_product(*args)[source]

      Returns a TensorSymmetry object that is being a direct product of fully (anti-)symmetric index permutation groups.

      Notes

      @@ -1550,20 +1550,20 @@
      Documentation Version
      -classmethod fully_symmetric(rank)[source]
      +classmethod fully_symmetric(rank)[source]

      Returns a fully symmetric (antisymmetric if rank``<0) TensorSymmetry object for ``abs(rank) indices.

      -classmethod no_symmetry(rank)[source]
      +classmethod no_symmetry(rank)[source]

      TensorSymmetry object for rank indices with no symmetry

      -classmethod riemann()[source]
      +classmethod riemann()[source]

      Returns a monotorem symmetry of the Riemann tensor

      @@ -1571,7 +1571,7 @@
      Documentation Version
      -sympy.tensor.tensor.tensorsymmetry(*args)[source]
      +sympy.tensor.tensor.tensorsymmetry(*args)[source]

      Returns a TensorSymmetry object. This method is deprecated, use TensorSymmetry.direct_product() or .riemann() instead.

      Explanation

      @@ -1600,7 +1600,7 @@
      Documentation Version
      -class sympy.tensor.tensor.TensorType(*args, **kwargs)[source]
      +class sympy.tensor.tensor.TensorType(*args, **kwargs)[source]

      Class of tensor types. Deprecated, use tensor_heads() instead.

      Parameters:
      @@ -1628,7 +1628,7 @@
      Documentation Version
      -class sympy.tensor.tensor._TensorManager[source]
      +class sympy.tensor.tensor._TensorManager[source]

      Class to manage tensor properties.

      Notes

      Tensors belong to tensor commutation groups; each group has a label @@ -1641,19 +1641,19 @@

      Documentation Version
      do not commute with any other group.

      -clear()[source]
      +clear()[source]

      Clear the TensorManager.

      -comm_i2symbol(i)[source]
      +comm_i2symbol(i)[source]

      Returns the symbol corresponding to the commutation group number.

      -comm_symbols2i(i)[source]
      +comm_symbols2i(i)[source]

      Get the commutation group number corresponding to i.

      i can be a symbol or a number or a string.

      If i is not already defined its commutation group number @@ -1662,14 +1662,14 @@

      Documentation Version
      -get_comm(i, j)[source]
      +get_comm(i, j)[source]

      Return the commutation parameter for commutation group numbers i, j

      see _TensorManager.set_comm

      -set_comm(i, j, c)[source]
      +set_comm(i, j, c)[source]

      Set the commutation parameter c for commutation groups i, j.

      Parameters:
      @@ -1711,7 +1711,7 @@
      Documentation Version
      -set_comms(*args)[source]
      +set_comms(*args)[source]

      Set the commutation group numbers c for symbols i, j.

      Parameters:
      diff --git a/dev/modules/tensor/toperators.html b/dev/modules/tensor/toperators.html index 223194fed21..d83ec08c0d0 100644 --- a/dev/modules/tensor/toperators.html +++ b/dev/modules/tensor/toperators.html @@ -805,7 +805,7 @@
      Documentation Version

      Tensor Operators

      -class sympy.tensor.toperators.PartialDerivative(expr, *variables)[source]
      +class sympy.tensor.toperators.PartialDerivative(expr, *variables)[source]

      Partial derivative for tensor expressions.

      Examples

      >>> from sympy.tensor.tensor import TensorIndexType, TensorHead
      diff --git a/dev/modules/testing/pytest.html b/dev/modules/testing/pytest.html
      index eba59afca3a..711ca707417 100644
      --- a/dev/modules/testing/pytest.html
      +++ b/dev/modules/testing/pytest.html
      @@ -806,19 +806,19 @@ 
      Documentation Version

      py.test hacks to support XFAIL/XPASS

      -sympy.testing.pytest.SKIP(reason)[source]
      +sympy.testing.pytest.SKIP(reason)[source]

      Similar to skip(), but this is a decorator.

      -sympy.testing.pytest.nocache_fail(func)[source]
      +sympy.testing.pytest.nocache_fail(func)[source]

      Dummy decorator for marking tests that fail when cache is disabled

      -sympy.testing.pytest.raises(expectedException, code=None)[source]
      +sympy.testing.pytest.raises(expectedException, code=None)[source]

      Tests that code raises the exception expectedException.

      code may be a callable, such as a lambda expression or function name.

      @@ -870,7 +870,7 @@
      Documentation Version
      -sympy.testing.pytest.skip_under_pyodide(message)[source]
      +sympy.testing.pytest.skip_under_pyodide(message)[source]

      Decorator to skip a test if running under pyodide.

      @@ -885,7 +885,7 @@
      Documentation Version
      test_stacklevel=True,
      -)[source] +)[source]

      Like raises but tests that warnings are emitted.

      >>> from sympy.testing.pytest import warns
       >>> import warnings
      @@ -914,7 +914,7 @@ 
      Documentation Version
      -sympy.testing.pytest.warns_deprecated_sympy()[source]
      +sympy.testing.pytest.warns_deprecated_sympy()[source]

      Shorthand for warns(SymPyDeprecationWarning)

      This is the recommended way to test that SymPyDeprecationWarning is emitted for deprecated features in SymPy. To test for other warnings use diff --git a/dev/modules/testing/runtests.html b/dev/modules/testing/runtests.html index 68f81576f17..e1a1792fd98 100644 --- a/dev/modules/testing/runtests.html +++ b/dev/modules/testing/runtests.html @@ -825,7 +825,7 @@

      Documentation Version
      split=None,
      -)[source] +)[source]

      Py.test like reporter. Should produce output identical to py.test.

      @@ -839,7 +839,7 @@
      Documentation Version
      force_colors=False,
      -)[source] +)[source]

      Prints a text on the screen.

      It uses sys.stdout.write(), so no readline library is necessary.

      @@ -859,7 +859,7 @@
      Documentation Version
      -class sympy.testing.runtests.Reporter[source]
      +class sympy.testing.runtests.Reporter[source]

      Parent class for all reporters.

      @@ -874,7 +874,7 @@
      Documentation Version
      exclude_empty=True,
      -)[source] +)[source]

      A class used to extract the DocTests that are relevant to a given object, from its docstring and the docstrings of its contained objects. Doctests can currently be extracted from the following @@ -896,7 +896,7 @@

      Documentation Version
      optionflags=0,
      -)[source] +)[source]

      A class used to run DocTest test cases, and accumulate statistics. The run method is used to process a single DocTest case. It returns a tuple (f, t), where t is the number of test cases @@ -915,7 +915,7 @@

      Documentation Version
      clear_globs=True,
      -)[source] +)[source]

      Run the examples in test, and display the results using the writer function out.

      The examples are run in the namespace test.globs. If @@ -936,7 +936,7 @@

      Documentation Version
      -class sympy.testing.runtests.SymPyOutputChecker[source]
      +class sympy.testing.runtests.SymPyOutputChecker[source]

      Compared to the OutputChecker from the stdlib our OutputChecker class supports numerical comparison of floats occurring in the output of the doctest examples

      @@ -950,7 +950,7 @@
      Documentation Version
      optionflags,
      -)[source] +)[source]

      Return True iff the actual output from an example (\(got\)) matches the expected output (\(want\)). These strings are always considered to match if they are identical; but @@ -964,7 +964,7 @@

      Documentation Version
      -class sympy.testing.runtests.SymPyTestResults(failed, attempted)[source]
      +class sympy.testing.runtests.SymPyTestResults(failed, attempted)[source]
      attempted
      @@ -981,7 +981,7 @@
      Documentation Version
      -sympy.testing.runtests.convert_to_native_paths(lst)[source]
      +sympy.testing.runtests.convert_to_native_paths(lst)[source]

      Converts a list of ‘/’ separated paths into a list of native (os.sep separated) paths and converts to lowercase if the system is case insensitive.

      @@ -998,7 +998,7 @@
      Documentation Version
      **kwargs,
      -)[source] +)[source]

      Runs doctests in all *.py files in the SymPy directory which match any of the given strings in paths or all tests if paths=[].

      Notes:

      @@ -1047,14 +1047,14 @@
      Documentation Version
      -sympy.testing.runtests.get_sympy_dir()[source]
      +sympy.testing.runtests.get_sympy_dir()[source]

      Returns the root SymPy directory and set the global value indicating whether the system is case sensitive or not.

      -sympy.testing.runtests.raise_on_deprecated()[source]
      +sympy.testing.runtests.raise_on_deprecated()[source]

      Context manager to make DeprecationWarning raise an error

      This is to catch SymPyDeprecationWarning from library code while running tests and doctests. It is important to use this context manager around @@ -1075,7 +1075,7 @@

      Documentation Version
      examples_kwargs=None,
      -)[source] +)[source]

      Run all tests.

      Right now, this runs the regular tests (bin/test), the doctests (bin/doctest), and the examples (examples/all.py).

      @@ -1104,7 +1104,7 @@
      Documentation Version
      force=False,
      -)[source] +)[source]

      Run a function in a Python subprocess with hash randomization enabled.

      If hash randomization is not supported by the version of Python given, it returns False. Otherwise, it returns the exit value of the command. The @@ -1147,7 +1147,7 @@

      Documentation Version
      -sympy.testing.runtests.split_list(l, split, density=None)[source]
      +sympy.testing.runtests.split_list(l, split, density=None)[source]

      Splits a list into part a of b

      split should be a string of the form ‘a/b’. For instance, ‘1/3’ would give the split one of three.

      @@ -1187,7 +1187,7 @@
      Documentation Version
      encoding=None,
      -)[source] +)[source]

      Test examples in the given file. Return (#failures, #tests).

      Optional keyword arg module_relative specifies how filenames should be interpreted:

      @@ -1255,7 +1255,7 @@
      Documentation Version
      -sympy.testing.runtests.test(*paths, subprocess=True, rerun=0, **kwargs)[source]
      +sympy.testing.runtests.test(*paths, subprocess=True, rerun=0, **kwargs)[source]

      Run tests in the specified test_*.py files.

      Tests in a particular test_*.py file are run if any of the given strings in paths matches a part of the test file’s path. If paths=[], diff --git a/dev/modules/utilities/autowrap.html b/dev/modules/utilities/autowrap.html index bf145a2eb8e..edb5e8748bd 100644 --- a/dev/modules/utilities/autowrap.html +++ b/dev/modules/utilities/autowrap.html @@ -940,17 +940,17 @@

      Implementation detailsverbose=False,

      -)[source] +)[source]

      Base Class for code wrappers

      -class sympy.utilities.autowrap.CythonCodeWrapper(*args, **kwargs)[source]
      +class sympy.utilities.autowrap.CythonCodeWrapper(*args, **kwargs)[source]

      Wrapper that uses Cython

      -dump_pyx(routines, f, prefix)[source]
      +dump_pyx(routines, f, prefix)[source]

      Write a Cython file with Python wrappers

      This file contains all the definitions of the routines in c code and refers to the header file.

      @@ -979,19 +979,19 @@

      Implementation detailsverbose=False,

      -)[source] +)[source]

      Class used for testing independent of backends

      -class sympy.utilities.autowrap.F2PyCodeWrapper(*args, **kwargs)[source]
      +class sympy.utilities.autowrap.F2PyCodeWrapper(*args, **kwargs)[source]

      Wrapper that uses f2py

      -class sympy.utilities.autowrap.UfuncifyCodeWrapper(*args, **kwargs)[source]
      +class sympy.utilities.autowrap.UfuncifyCodeWrapper(*args, **kwargs)[source]

      Wrapper for Ufuncify

      @@ -1004,7 +1004,7 @@

      Implementation detailsfuncname=None,

      -)[source] +)[source]

      Write a C file with Python wrappers

      This file contains all the definitions of the routines in c code.

      Arguments

      @@ -1039,7 +1039,7 @@

      Implementation details**kwargs,

      -)[source] +)[source]

      Generates Python callable binaries based on the math expression.

      Parameters:
      @@ -1134,7 +1134,7 @@

      Implementation details
      -sympy.utilities.autowrap.binary_function(symfunc, expr, **kwargs)[source]
      +sympy.utilities.autowrap.binary_function(symfunc, expr, **kwargs)[source]

      Returns a SymPy function with expr as binary implementation

      This is a convenience function that automates the steps needed to autowrap the SymPy expression and attaching it to a Function object @@ -1186,7 +1186,7 @@

      Implementation details**kwargs,

      -)[source] +)[source]

      Generates a binary function that supports broadcasting on numpy arrays.

      Parameters:
      diff --git a/dev/modules/utilities/codegen.html b/dev/modules/utilities/codegen.html index 2b32300faf3..9e7d980fbfb 100644 --- a/dev/modules/utilities/codegen.html +++ b/dev/modules/utilities/codegen.html @@ -927,7 +927,7 @@

      Routine
      precision=None,

      -)[source] +)[source]

      An abstract Argument data structure: a name and a data type.

      This structure is refined in the descendants below.

      @@ -943,7 +943,7 @@

      Routine
      cse=False,

      -)[source] +)[source]

      Generator for C code.

      The .write() method inherited from CodeGen will output a code file and an interface file, <prefix>.c and <prefix>.h respectively.

      @@ -959,7 +959,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Write the code by calling language specific methods.

      The generated file contains all the definitions of the routines in low-level code and refers to the header file if appropriate.

      @@ -1004,7 +1004,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Writes the C header file.

      This file contains all the function declarations.

      @@ -1038,7 +1038,7 @@

      Routine
      -get_prototype(routine)[source]
      +get_prototype(routine)[source]

      Returns a string for the function prototype of the routine.

      If the routine has multiple result objects, an CodeGenError is raised.

      @@ -1049,7 +1049,7 @@

      Routine
      -class sympy.utilities.codegen.CodeGen(project='project', cse=False)[source]
      +class sympy.utilities.codegen.CodeGen(project='project', cse=False)[source]

      Abstract class for the code generators.

      @@ -1063,7 +1063,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Write the code by calling language specific methods.

      The generated file contains all the definitions of the routines in low-level code and refers to the header file if appropriate.

      @@ -1107,7 +1107,7 @@

      Routine
      global_vars=None,

      -)[source] +)[source]

      Creates an Routine object that is appropriate for this language.

      This implementation is appropriate for at least C/Fortran. Subclasses can override this if necessary.

      @@ -1131,7 +1131,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Writes all the source code files for the given routines.

      The generated source is returned as a list of (filename, contents) tuples, or is written to files (see below). Each filename consists @@ -1180,13 +1180,13 @@

      Routine
      rsname,

      -)[source] +)[source]

      Holds strings for a certain datatype in different languages.

      -class sympy.utilities.codegen.FCodeGen(project='project', printer=None)[source]
      +class sympy.utilities.codegen.FCodeGen(project='project', printer=None)[source]

      Generator for Fortran 95 code

      The .write() method inherited from CodeGen will output a code file and an interface file, <prefix>.f90 and <prefix>.h respectively.

      @@ -1202,7 +1202,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Write the code by calling language specific methods.

      The generated file contains all the definitions of the routines in low-level code and refers to the header file if appropriate.

      @@ -1247,7 +1247,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Writes the interface to a header file.

      This file contains all the function declarations.

      @@ -1280,7 +1280,7 @@

      Routine
      -get_interface(routine)[source]
      +get_interface(routine)[source]

      Returns a string for the function interface.

      The routine should have a single result object, which can be None. If the routine has multiple result objects, a CodeGenError is @@ -1292,7 +1292,7 @@

      Routine
      -class sympy.utilities.codegen.JuliaCodeGen(project='project', printer=None)[source]
      +class sympy.utilities.codegen.JuliaCodeGen(project='project', printer=None)[source]

      Generator for Julia code.

      The .write() method inherited from CodeGen will output a code file <prefix>.jl.

      @@ -1308,7 +1308,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Write the code by calling language specific methods.

      The generated file contains all the definitions of the routines in low-level code and refers to the header file if appropriate.

      @@ -1352,7 +1352,7 @@

      Routine
      global_vars,

      -)[source] +)[source]

      Specialized Routine creation for Julia.

      @@ -1360,7 +1360,7 @@

      Routine
      -class sympy.utilities.codegen.OctaveCodeGen(project='project', printer=None)[source]
      +class sympy.utilities.codegen.OctaveCodeGen(project='project', printer=None)[source]

      Generator for Octave code.

      The .write() method inherited from CodeGen will output a code file <prefix>.m.

      @@ -1383,7 +1383,7 @@

      Routine
      inline=True,

      -)[source] +)[source]

      Write the code by calling language specific methods.

      The generated file contains all the definitions of the routines in low-level code and refers to the header file if appropriate.

      @@ -1427,7 +1427,7 @@

      Routine
      global_vars,

      -)[source] +)[source]

      Specialized Routine creation for Octave.

      @@ -1446,7 +1446,7 @@

      Routine
      precision=None,

      -)[source] +)[source]

      OutputArgument are always initialized in the routine.

      @@ -1463,7 +1463,7 @@

      Routine
      precision=None,

      -)[source] +)[source]

      An expression for a return value.

      The name result is used to avoid conflicts with the reserved word “return” in the Python language. It is also shorter than ReturnValue.

      @@ -1483,7 +1483,7 @@

      Routine
      global_vars,

      -)[source] +)[source]

      Generic description of evaluation routine for set of expressions.

      A CodeGen class can translate instances of this class into code in a particular language. The routine specification covers all the features @@ -1511,7 +1511,7 @@

      Routine
      -class sympy.utilities.codegen.RustCodeGen(project='project', printer=None)[source]
      +class sympy.utilities.codegen.RustCodeGen(project='project', printer=None)[source]

      Generator for Rust code.

      The .write() method inherited from CodeGen will output a code file <prefix>.rs

      @@ -1527,7 +1527,7 @@

      Routine
      empty=True,

      -)[source] +)[source]

      Write the code by calling language specific methods.

      The generated file contains all the definitions of the routines in low-level code and refers to the header file if appropriate.

      @@ -1562,7 +1562,7 @@

      Routine
      -get_prototype(routine)[source]
      +get_prototype(routine)[source]

      Returns a string for the function prototype of the routine.

      If the routine has multiple result objects, an CodeGenError is raised.

      @@ -1580,7 +1580,7 @@

      Routine
      global_vars,

      -)[source] +)[source]

      Specialized Routine creation for Rust.

      @@ -1605,7 +1605,7 @@

      Routine
      printer=None,

      -)[source] +)[source]

      Generate source code for expressions in a given language.

      Parameters:
      @@ -1743,7 +1743,7 @@

      Routine
      -sympy.utilities.codegen.get_default_datatype(expr, complex_allowed=None)[source]
      +sympy.utilities.codegen.get_default_datatype(expr, complex_allowed=None)[source]

      Derives an appropriate datatype based on the expression.

      @@ -1759,7 +1759,7 @@

      Routine
      language='F95',

      -)[source] +)[source]

      A factory that makes an appropriate Routine from an expression.

      Parameters:
      diff --git a/dev/modules/utilities/decorator.html b/dev/modules/utilities/decorator.html index fd3b5782133..16b6eff828a 100644 --- a/dev/modules/utilities/decorator.html +++ b/dev/modules/utilities/decorator.html @@ -816,7 +816,7 @@
      Documentation Version
      stacklevel=3,
      -)[source] +)[source]

      Mark a function as deprecated.

      This decorator should be used if an entire function or class is deprecated. If only a certain functionality is deprecated, you should use @@ -879,7 +879,7 @@

      Documentation Version
      -sympy.utilities.decorator.conserve_mpmath_dps(func)[source]
      +sympy.utilities.decorator.conserve_mpmath_dps(func)[source]

      After the function finishes, resets the value of mpmath.mp.dps to the value it had before the function was run.

      @@ -896,7 +896,7 @@
      Documentation Version
      ground_types=None,

      -)[source] +)[source]

      Adds metadata about the dependencies which need to be met for doctesting the docstrings of the decorated objects.

      exe should be a list of executables

      @@ -908,7 +908,7 @@
      Documentation Version
      -sympy.utilities.decorator.memoize_property(propfunc)[source]
      +sympy.utilities.decorator.memoize_property(propfunc)[source]

      Property decorator that caches the value of potentially expensive propfunc after the first evaluation. The cached value is stored in the corresponding property name with an attached underscore.

      @@ -916,7 +916,7 @@
      Documentation Version
      -class sympy.utilities.decorator.no_attrs_in_subclass(cls, f)[source]
      +class sympy.utilities.decorator.no_attrs_in_subclass(cls, f)[source]

      Don’t ‘inherit’ certain attributes from a base class

      >>> from sympy.utilities.decorator import no_attrs_in_subclass
       
      @@ -948,7 +948,7 @@
      Documentation Version
      obj: T,
      -) T[source] +) T[source]

      Append obj’s name to global __all__ variable (call site).

      By using this decorator on functions or classes you achieve the same goal as by filling __all__ variables manually, you just do not have to repeat @@ -981,7 +981,7 @@

      Documentation Version
      -sympy.utilities.decorator.threaded(func)[source]
      +sympy.utilities.decorator.threaded(func)[source]

      Apply func to sub–elements of an object, including Add.

      This decorator is intended to make it uniformly possible to apply a function to all elements of composite objects, e.g. matrices, lists, tuples @@ -998,13 +998,13 @@

      Documentation Version
      -sympy.utilities.decorator.threaded_factory(func, use_add)[source]
      +sympy.utilities.decorator.threaded_factory(func, use_add)[source]

      A factory for threaded decorators.

      -sympy.utilities.decorator.xthreaded(func)[source]
      +sympy.utilities.decorator.xthreaded(func)[source]

      Apply func to sub–elements of an object, excluding Add.

      This decorator is intended to make it uniformly possible to apply a function to all elements of composite objects, e.g. matrices, lists, tuples diff --git a/dev/modules/utilities/enumerative.html b/dev/modules/utilities/enumerative.html index ed1ca8c8ff8..026c4cfc5c9 100644 --- a/dev/modules/utilities/enumerative.html +++ b/dev/modules/utilities/enumerative.html @@ -807,7 +807,7 @@

      Documentation Version
      counting multiset partitions.

      -sympy.utilities.enumerative.multiset_partitions_taocp(multiplicities)[source]
      +sympy.utilities.enumerative.multiset_partitions_taocp(multiplicities)[source]

      Enumerates partitions of a multiset.

      Parameters:
      @@ -870,7 +870,7 @@
      Documentation Version
      -sympy.utilities.enumerative.factoring_visitor(state, primes)[source]
      +sympy.utilities.enumerative.factoring_visitor(state, primes)[source]

      Use with multiset_partitions_taocp to enumerate the ways a number can be expressed as a product of factors. For this usage, the exponents of the prime factors of a number are arguments to @@ -897,7 +897,7 @@

      Documentation Version
      -sympy.utilities.enumerative.list_visitor(state, components)[source]
      +sympy.utilities.enumerative.list_visitor(state, components)[source]

      Return a list of lists to represent the partition.

      Examples

      >>> from sympy.utilities.enumerative import list_visitor
      @@ -917,7 +917,7 @@ 
      Documentation Version
      and generalized by the class MultisetPartitionTraverser.

      -class sympy.utilities.enumerative.MultisetPartitionTraverser[source]
      +class sympy.utilities.enumerative.MultisetPartitionTraverser[source]

      Has methods to enumerate and count the partitions of a multiset.

      This implements a refactored and extended version of Knuth’s algorithm 7.1.2.5M [AOCP].”

      @@ -967,7 +967,7 @@
      Documentation Version
      multiplicities,
      -)[source] +)[source]

      Returns the number of partitions of a multiset whose components have the multiplicities given in multiplicities.

      For larger counts, this method is much faster than calling one @@ -1038,7 +1038,7 @@

      Documentation Version
      multiplicities,
      -)[source] +)[source]

      Enumerate the partitions of a multiset.

      Examples

      >>> from sympy.utilities.enumerative import list_visitor
      @@ -1075,7 +1075,7 @@ 
      Documentation Version
      lb,
      -)[source] +)[source]

      Enumerate the partitions of a multiset with lb < num(parts)

      Equivalent to enum_range(multiplicities, lb, sum(multiplicities))

      @@ -1119,7 +1119,7 @@
      Documentation Version
      ub,
      -)[source] +)[source]

      Enumerate the partitions of a multiset with lb < num(parts) <= ub.

      In particular, if partitions with exactly k parts are @@ -1148,7 +1148,7 @@

      Documentation Version
      ub,
      -)[source] +)[source]

      Enumerate multiset partitions with no more than ub parts.

      Equivalent to enum_range(multiplicities, 0, ub)

      diff --git a/dev/modules/utilities/exceptions.html b/dev/modules/utilities/exceptions.html index c227b6a5316..bbfb573e78c 100644 --- a/dev/modules/utilities/exceptions.html +++ b/dev/modules/utilities/exceptions.html @@ -815,7 +815,7 @@
      Documentation Version
      active_deprecations_target,
      -)[source] +)[source]

      A warning for deprecated features of SymPy.

      See the Deprecation Policy document for details on when and how things should be deprecated in SymPy.

      @@ -846,7 +846,7 @@
      Documentation Version
      -sympy.utilities.exceptions.ignore_warnings(warningcls)[source]
      +sympy.utilities.exceptions.ignore_warnings(warningcls)[source]

      Context manager to suppress warnings during tests.

      Note

      @@ -901,7 +901,7 @@
      Documentation Version
      stacklevel=3,
      -)[source] +)[source]

      Warn that a feature is deprecated in SymPy.

      See the Deprecation Policy document for details on when and how things should be deprecated in SymPy.

      diff --git a/dev/modules/utilities/iterables.html b/dev/modules/utilities/iterables.html index 723f90d5730..304a88931e7 100644 --- a/dev/modules/utilities/iterables.html +++ b/dev/modules/utilities/iterables.html @@ -805,7 +805,7 @@
      Documentation Version

      Iterables

      -class sympy.utilities.iterables.NotIterable[source]
      +class sympy.utilities.iterables.NotIterable[source]

      Use this as mixin when creating a class which is not supposed to return true when iterable() is called on its instances because calling list() on the instance, for example, would result in @@ -814,7 +814,7 @@

      Documentation Version
      -sympy.utilities.iterables.binary_partitions(n)[source]
      +sympy.utilities.iterables.binary_partitions(n)[source]

      Generates the binary partition of n.

      A binary partition consists only of numbers that are powers of two. Each step reduces a \(2^{k+1}\) to \(2^k\) and @@ -841,13 +841,13 @@

      Documentation Version
      -sympy.utilities.iterables.bracelets(n, k)[source]
      +sympy.utilities.iterables.bracelets(n, k)[source]

      Wrapper to necklaces to return a free (unrestricted) necklace.

      -sympy.utilities.iterables.capture(func)[source]
      +sympy.utilities.iterables.capture(func)[source]

      Return the printed output of func().

      func should be a function without arguments that produces output with print statements.

      @@ -867,7 +867,7 @@
      Documentation Version
      -sympy.utilities.iterables.common_prefix(*seqs)[source]
      +sympy.utilities.iterables.common_prefix(*seqs)[source]

      Return the subsequence that is a common start of sequences in seqs.

      >>> from sympy.utilities.iterables import common_prefix
       >>> common_prefix(list(range(3)))
      @@ -884,7 +884,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.common_suffix(*seqs)[source]
      +sympy.utilities.iterables.common_suffix(*seqs)[source]

      Return the subsequence that is a common ending of sequences in seqs.

      >>> from sympy.utilities.iterables import common_suffix
       >>> common_suffix(list(range(3)))
      @@ -901,7 +901,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.connected_components(G)[source]
      +sympy.utilities.iterables.connected_components(G)[source]

      Connected components of an undirected graph or weakly connected components of a directed graph.

      @@ -962,13 +962,13 @@
      Documentation Version
      -sympy.utilities.iterables.dict_merge(*dicts)[source]
      +sympy.utilities.iterables.dict_merge(*dicts)[source]

      Merge dictionaries into a single dictionary.

      -sympy.utilities.iterables.filter_symbols(iterator, exclude)[source]
      +sympy.utilities.iterables.filter_symbols(iterator, exclude)[source]

      Only yield elements from \(iterator\) that do not occur in \(exclude\).

      Parameters:
      @@ -992,7 +992,7 @@
      Documentation Version
      -sympy.utilities.iterables.flatten(iterable, levels=None, cls=None)[source]
      +sympy.utilities.iterables.flatten(iterable, levels=None, cls=None)[source]

      Recursively denest iterable containers.

      >>> from sympy import flatten
       
      @@ -1032,7 +1032,7 @@
      Documentation Version
      -sympy.utilities.iterables.generate_bell(n)[source]
      +sympy.utilities.iterables.generate_bell(n)[source]

      Return permutations of [0, 1, …, n - 1] such that each permutation differs from the last by the exchange of a single pair of neighbors. The n! permutations are returned as an iterator. In order to obtain @@ -1106,7 +1106,7 @@

      Documentation Version
      -sympy.utilities.iterables.generate_derangements(s)[source]
      +sympy.utilities.iterables.generate_derangements(s)[source]

      Return unique derangements of the elements of iterable s.

      Examples

      >>> from sympy.utilities.iterables import generate_derangements
      @@ -1126,7 +1126,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.generate_involutions(n)[source]
      +sympy.utilities.iterables.generate_involutions(n)[source]

      Generates involutions.

      An involution is a permutation that when multiplied by itself equals the identity permutation. In this @@ -1154,7 +1154,7 @@

      Documentation Version
      -sympy.utilities.iterables.generate_oriented_forest(n)[source]
      +sympy.utilities.iterables.generate_oriented_forest(n)[source]

      This algorithm generates oriented forests.

      An oriented graph is a directed graph having no symmetric pair of directed edges. A forest is an acyclic graph, i.e., it has no cycles. A forest can @@ -1182,7 +1182,7 @@

      Documentation Version
      -sympy.utilities.iterables.group(seq, multiple=True)[source]
      +sympy.utilities.iterables.group(seq, multiple=True)[source]

      Splits a sequence into a list of lists of equal, adjacent elements.

      Examples

      >>> from sympy import group
      @@ -1204,7 +1204,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.has_dups(seq)[source]
      +sympy.utilities.iterables.has_dups(seq)[source]

      Return True if there are any duplicate elements in seq.

      Examples

      >>> from sympy import has_dups, Dict, Set
      @@ -1220,7 +1220,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.has_variety(seq)[source]
      +sympy.utilities.iterables.has_variety(seq)[source]

      Return True if there are any different elements in seq.

      Examples

      >>> from sympy import has_variety
      @@ -1236,7 +1236,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.ibin(n, bits=None, str=False)[source]
      +sympy.utilities.iterables.ibin(n, bits=None, str=False)[source]

      Return a list of length bits corresponding to the binary value of n with small bits to the right (last). If bits is omitted, the length will be the number required to represent n. If the bits are @@ -1279,7 +1279,7 @@

      Documentation Version
      -sympy.utilities.iterables.iproduct(*iterables)[source]
      +sympy.utilities.iterables.iproduct(*iterables)[source]

      Cartesian product of iterables.

      Generator of the Cartesian product of iterables. This is analogous to itertools.product except that it works with infinite iterables and will @@ -1306,7 +1306,7 @@

      Documentation Version
      -sympy.utilities.iterables.is_palindromic(s, i=0, j=None)[source]
      +sympy.utilities.iterables.is_palindromic(s, i=0, j=None)[source]

      Return True if the sequence is the same from left to right as it is from right to left in the whole sequence (default) or in the Python slice s[i: j]; else False.

      @@ -1339,7 +1339,7 @@
      Documentation Version
      -sympy.utilities.iterables.is_sequence(i, include=None)[source]
      +sympy.utilities.iterables.is_sequence(i, include=None)[source]

      Return a boolean indicating whether i is a sequence in the SymPy sense. If anything that fails the test below should be included as being a sequence for your application, set ‘include’ to that object’s @@ -1380,7 +1380,7 @@

      Documentation Version
      <class 'sympy.utilities.iterables.NotIterable'>),
      -)[source] +)[source]

      Return a boolean indicating whether i is SymPy iterable. True also indicates that the iterator is finite, e.g. you can call list(…) on the instance.

      @@ -1424,7 +1424,7 @@
      Documentation Version
      -sympy.utilities.iterables.kbins(l, k, ordered=None)[source]
      +sympy.utilities.iterables.kbins(l, k, ordered=None)[source]

      Return sequence l partitioned into k bins.

      Examples

      The default is to give the items in the same order, but grouped @@ -1504,7 +1504,7 @@

      Documentation Version
      -sympy.utilities.iterables.least_rotation(x, key=None)[source]
      +sympy.utilities.iterables.least_rotation(x, key=None)[source]

      Returns the number of steps of left rotation required to obtain lexicographically minimal string/list/tuple, etc.

      Examples

      @@ -1527,7 +1527,7 @@
      Documentation Version
      -sympy.utilities.iterables.minlex(seq, directed=True, key=None)[source]
      +sympy.utilities.iterables.minlex(seq, directed=True, key=None)[source]

      Return the rotation of the sequence in which the lexically smallest elements appear first, e.g. \(cba \rightarrow acb\).

      The sequence returned is a tuple, unless the input sequence is a string @@ -1561,7 +1561,7 @@

      Documentation Version
      -sympy.utilities.iterables.multiset(seq)[source]
      +sympy.utilities.iterables.multiset(seq)[source]

      Return the hashable sequence in multiset form with values being the multiplicity of the item in the sequence.

      Examples

      @@ -1578,7 +1578,7 @@
      Documentation Version
      -sympy.utilities.iterables.multiset_combinations(m, n, g=None)[source]
      +sympy.utilities.iterables.multiset_combinations(m, n, g=None)[source]

      Return the unique combinations of size n from multiset m.

      Examples

      >>> from sympy.utilities.iterables import multiset_combinations
      @@ -1605,7 +1605,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.multiset_derangements(s)[source]
      +sympy.utilities.iterables.multiset_derangements(s)[source]

      Generate derangements of the elements of s in place.

      Examples

      >>> from sympy.utilities.iterables import multiset_derangements, uniq
      @@ -1626,7 +1626,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.multiset_partitions(multiset, m=None)[source]
      +sympy.utilities.iterables.multiset_partitions(multiset, m=None)[source]

      Return unique partitions of the given multiset (in list form). If m is None, all multisets will be returned, otherwise only partitions with m parts will be returned.

      @@ -1690,7 +1690,7 @@
      Documentation Version
      -sympy.utilities.iterables.multiset_permutations(m, size=None, g=None)[source]
      +sympy.utilities.iterables.multiset_permutations(m, size=None, g=None)[source]

      Return the unique permutations of multiset m.

      Examples

      >>> from sympy.utilities.iterables import multiset_permutations
      @@ -1707,7 +1707,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.necklaces(n, k, free=False)[source]
      +sympy.utilities.iterables.necklaces(n, k, free=False)[source]

      A routine to generate necklaces that may (free=True) or may not (free=False) be turned over to be viewed. The “necklaces” returned are comprised of n integers (beads) with k different @@ -1768,7 +1768,7 @@

      Documentation Version
      **assumptions,
      -)[source] +)[source]

      Generate an infinite stream of Symbols consisting of a prefix and increasing subscripts provided that they do not occur in exclude.

      @@ -1807,7 +1807,7 @@
      Documentation Version
      -sympy.utilities.iterables.ordered_partitions(n, m=None, sort=True)[source]
      +sympy.utilities.iterables.ordered_partitions(n, m=None, sort=True)[source]

      Generates ordered partitions of integer n.

      Parameters:
      @@ -1897,7 +1897,7 @@
      Documentation Version
      -sympy.utilities.iterables.partitions(n, m=None, k=None, size=False)[source]
      +sympy.utilities.iterables.partitions(n, m=None, k=None, size=False)[source]

      Generate all partitions of positive integer, n.

      Each partition is represented as a dictionary, mapping an integer to the number of copies of that integer in the partition. For example, @@ -1963,7 +1963,7 @@

      Documentation Version
      -sympy.utilities.iterables.permute_signs(t)[source]
      +sympy.utilities.iterables.permute_signs(t)[source]

      Return iterator in which the signs of non-zero elements of t are permuted.

      Examples

      @@ -1976,7 +1976,7 @@
      Documentation Version
      -sympy.utilities.iterables.postfixes(seq)[source]
      +sympy.utilities.iterables.postfixes(seq)[source]

      Generate all postfixes of a sequence.

      Examples

      >>> from sympy.utilities.iterables import postfixes
      @@ -1990,7 +1990,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.prefixes(seq)[source]
      +sympy.utilities.iterables.prefixes(seq)[source]

      Generate all prefixes of a sequence.

      Examples

      >>> from sympy.utilities.iterables import prefixes
      @@ -2004,7 +2004,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.random_derangement(t, choice=None, strict=True)[source]
      +sympy.utilities.iterables.random_derangement(t, choice=None, strict=True)[source]

      Return a list of elements in which none are in the same positions as they were originally. If an element fills more than half of the positions then an error will be raised since no derangement is possible. To obtain @@ -2038,7 +2038,7 @@

      Documentation Version
      -sympy.utilities.iterables.reshape(seq, how)[source]
      +sympy.utilities.iterables.reshape(seq, how)[source]

      Reshape the sequence according to the template in how.

      Examples

      >>> from sympy.utilities import reshape
      @@ -2085,7 +2085,7 @@ 
      Documentation Version
      -sympy.utilities.iterables.rotate_left(x, y)[source]
      +sympy.utilities.iterables.rotate_left(x, y)[source]

      Left rotates a list x by the number of steps specified in y.

      Examples

      @@ -2099,7 +2099,7 @@
      Documentation Version
      -sympy.utilities.iterables.rotate_right(x, y)[source]
      +sympy.utilities.iterables.rotate_right(x, y)[source]

      Right rotates a list x by the number of steps specified in y.

      Examples

      @@ -2113,7 +2113,7 @@
      Documentation Version
      -sympy.utilities.iterables.rotations(s, dir=1)[source]
      +sympy.utilities.iterables.rotations(s, dir=1)[source]

      Return a generator giving the items in s as list where each subsequent list has the items rotated to the left (default) or right (dir=-1) relative to the previous list.

      @@ -2129,7 +2129,7 @@
      Documentation Version
      -sympy.utilities.iterables.roundrobin(*iterables)[source]
      +sympy.utilities.iterables.roundrobin(*iterables)[source]

      roundrobin recipe taken from itertools documentation: https://docs.python.org/3/library/itertools.html#itertools-recipes

      roundrobin(‘ABC’, ‘D’, ‘EF’) –> A D E B F C

      @@ -2138,7 +2138,7 @@
      Documentation Version
      -sympy.utilities.iterables.runs(seq, op=<built-in function gt>)[source]
      +sympy.utilities.iterables.runs(seq, op=<built-in function gt>)[source]

      Group the sequence into lists in which successive elements all compare the same with the comparison operator, op: op(seq[i + 1], seq[i]) is True from all elements in a run.

      @@ -2155,7 +2155,7 @@
      Documentation Version
      -sympy.utilities.iterables.sequence_partitions(l, n, /)[source]
      +sympy.utilities.iterables.sequence_partitions(l, n, /)[source]

      Returns the partition of sequence \(l\) into \(n\) bins

      Parameters:
      @@ -2205,7 +2205,7 @@
      Documentation Version
      -sympy.utilities.iterables.sequence_partitions_empty(l, n, /)[source]
      +sympy.utilities.iterables.sequence_partitions_empty(l, n, /)[source]

      Returns the partition of sequence \(l\) into \(n\) bins with empty sequence

      @@ -2258,7 +2258,7 @@
      Documentation Version
      -sympy.utilities.iterables.sift(seq, keyfunc, binary=False)[source]
      +sympy.utilities.iterables.sift(seq, keyfunc, binary=False)[source]

      Sift the sequence, seq according to keyfunc.

      Returns:
      @@ -2330,7 +2330,7 @@
      Documentation Version
      -sympy.utilities.iterables.signed_permutations(t)[source]
      +sympy.utilities.iterables.signed_permutations(t)[source]

      Return iterator in which the signs of non-zero elements of t and the order of the elements are permuted and all returned values are unique.

      @@ -2348,7 +2348,7 @@
      Documentation Version
      -sympy.utilities.iterables.strongly_connected_components(G)[source]
      +sympy.utilities.iterables.strongly_connected_components(G)[source]

      Strongly connected components of a directed graph in reverse topological order.

      @@ -2422,7 +2422,7 @@
      Documentation Version
      -sympy.utilities.iterables.subsets(seq, k=None, repetition=False)[source]
      +sympy.utilities.iterables.subsets(seq, k=None, repetition=False)[source]

      Generates all \(k\)-subsets (combinations) from an \(n\)-element set, seq.

      A \(k\)-subset of an \(n\)-element set is any subset of length exactly \(k\). The number of \(k\)-subsets of an \(n\)-element set is given by binomial(n, k), @@ -2463,13 +2463,13 @@

      Documentation Version
      -sympy.utilities.iterables.take(iter, n)[source]
      +sympy.utilities.iterables.take(iter, n)[source]

      Return n items from iter iterator.

      -sympy.utilities.iterables.topological_sort(graph, key=None)[source]
      +sympy.utilities.iterables.topological_sort(graph, key=None)[source]

      Topological sort of graph’s vertices.

      Parameters:
      @@ -2544,14 +2544,14 @@
      Documentation Version
      -sympy.utilities.iterables.unflatten(iter, n=2)[source]
      +sympy.utilities.iterables.unflatten(iter, n=2)[source]

      Group iter into tuples of length n. Raise an error if the length of iter is not a multiple of n.

      -sympy.utilities.iterables.uniq(seq, result=None)[source]
      +sympy.utilities.iterables.uniq(seq, result=None)[source]

      Yield unique elements from seq as an iterator. The second parameter result is used internally; it is not necessary to pass anything for this.

      @@ -2578,7 +2578,7 @@
      Documentation Version
      -sympy.utilities.iterables.variations(seq, n, repetition=False)[source]
      +sympy.utilities.iterables.variations(seq, n, repetition=False)[source]

      Returns an iterator over the n-sized variations of seq (size N). repetition controls whether items in seq can appear more than once;

      Examples

      diff --git a/dev/modules/utilities/lambdify.html b/dev/modules/utilities/lambdify.html index 6f8ea5c356c..4f1a0719b34 100644 --- a/dev/modules/utilities/lambdify.html +++ b/dev/modules/utilities/lambdify.html @@ -807,7 +807,7 @@
      Documentation Version
      lambda functions which can be used to calculate numerical values very fast.

      -sympy.utilities.lambdify.implemented_function(symfunc, implementation)[source]
      +sympy.utilities.lambdify.implemented_function(symfunc, implementation)[source]

      Add numerical implementation to function symfunc.

      symfunc can be an UndefinedFunction instance, or a name string. In the latter case we create an UndefinedFunction instance with that @@ -850,7 +850,7 @@

      Documentation Version
      -sympy.utilities.lambdify.lambdastr(args, expr, printer=None, dummify=None)[source]
      +sympy.utilities.lambdify.lambdastr(args, expr, printer=None, dummify=None)[source]

      Returns a string that can be evaluated to a lambda function.

      Examples

      >>> from sympy.abc import x, y, z
      @@ -885,7 +885,7 @@ 
      Documentation Version
      docstring_limit=1000,
      -)[source] +)[source]

      Convert a SymPy expression into a function that allows for fast numeric evaluation.

      diff --git a/dev/modules/utilities/memoization.html b/dev/modules/utilities/memoization.html index 34035217524..1216be067b2 100644 --- a/dev/modules/utilities/memoization.html +++ b/dev/modules/utilities/memoization.html @@ -805,7 +805,7 @@
      Documentation Version

      Memoization

      -sympy.utilities.memoization.assoc_recurrence_memo(base_seq)[source]
      +sympy.utilities.memoization.assoc_recurrence_memo(base_seq)[source]

      Memo decorator for associated sequences defined by recurrence starting from base

      base_seq(n) – callable to get base sequence elements

      XXX works only for Pn0 = base_seq(0) cases @@ -814,7 +814,7 @@

      Documentation Version
      -sympy.utilities.memoization.recurrence_memo(initial)[source]
      +sympy.utilities.memoization.recurrence_memo(initial)[source]

      Memo decorator for sequences defined by recurrence

      Examples

      >>> from sympy.utilities.memoization import recurrence_memo
      diff --git a/dev/modules/utilities/misc.html b/dev/modules/utilities/misc.html
      index 2f55a1502e9..a6593390193 100644
      --- a/dev/modules/utilities/misc.html
      +++ b/dev/modules/utilities/misc.html
      @@ -806,7 +806,7 @@ 
      Documentation Version

      Miscellaneous stuff that does not really fit anywhere else.

      -sympy.utilities.misc.as_int(n, strict=True)[source]
      +sympy.utilities.misc.as_int(n, strict=True)[source]

      Convert the argument to a builtin integer.

      The return value is guaranteed to be equal to the input. ValueError is raised if the input has a non-integral value. When strict is True, this @@ -855,27 +855,27 @@

      Documentation Version
      -sympy.utilities.misc.debug(*args)[source]
      +sympy.utilities.misc.debug(*args)[source]

      Print *args if SYMPY_DEBUG is True, else do nothing.

      -sympy.utilities.misc.debug_decorator(func)[source]
      +sympy.utilities.misc.debug_decorator(func)[source]

      If SYMPY_DEBUG is True, it will print a nice execution tree with arguments and results of all decorated functions, else do nothing.

      -sympy.utilities.misc.debugf(string, args)[source]
      +sympy.utilities.misc.debugf(string, args)[source]

      Print string%args if SYMPY_DEBUG is True, else do nothing. This is intended for debug messages using formatted strings.

      -sympy.utilities.misc.filldedent(s, w=70, **kwargs)[source]
      +sympy.utilities.misc.filldedent(s, w=70, **kwargs)[source]

      Strips leading and trailing empty lines from a copy of s, then dedents, fills and returns it.

      Empty line stripping serves to deal with docstrings like this one that @@ -890,7 +890,7 @@

      Documentation Version
      -sympy.utilities.misc.find_executable(executable, path=None)[source]
      +sympy.utilities.misc.find_executable(executable, path=None)[source]

      Try to find ‘executable’ in the directories listed in ‘path’ (a string listing directories separated by ‘os.pathsep’; defaults to os.environ[‘PATH’]). Returns the complete filename or None if not @@ -899,7 +899,7 @@

      Documentation Version
      -sympy.utilities.misc.func_name(x, short=False)[source]
      +sympy.utilities.misc.func_name(x, short=False)[source]

      Return function name of \(x\) (if defined) else the \(type(x)\). If short is True and there is a shorter alias for the result, return the alias.

      @@ -919,13 +919,13 @@
      Documentation Version
      -sympy.utilities.misc.ordinal(num)[source]
      +sympy.utilities.misc.ordinal(num)[source]

      Return ordinal number string of num, e.g. 1 becomes 1st.

      -sympy.utilities.misc.rawlines(s)[source]
      +sympy.utilities.misc.rawlines(s)[source]

      Return a cut-and-pastable string that, when printed, is equivalent to the input. Use this when there is more than one line in the string. The string returned is formatted so it can be indented @@ -989,7 +989,7 @@

      Documentation Version
      -sympy.utilities.misc.replace(string, *reps)[source]
      +sympy.utilities.misc.replace(string, *reps)[source]

      Return string with all keys in reps replaced with their corresponding values, longer strings first, irrespective of the order they are given. reps may be passed as tuples @@ -1024,7 +1024,7 @@

      Documentation Version
      -sympy.utilities.misc.strlines(s, c=64, short=False)[source]
      +sympy.utilities.misc.strlines(s, c=64, short=False)[source]

      Return a cut-and-pastable string that, when printed, is equivalent to the input. The lines will be surrounded by parentheses and no line will be longer than c (default 64) @@ -1055,7 +1055,7 @@

      Documentation Version
      -sympy.utilities.misc.translate(s, a, b=None, c=None)[source]
      +sympy.utilities.misc.translate(s, a, b=None, c=None)[source]

      Return s where characters have been replaced or deleted.

      Syntax

      diff --git a/dev/modules/utilities/source.html b/dev/modules/utilities/source.html index 326cf5a33c4..3ccbf11d66f 100644 --- a/dev/modules/utilities/source.html +++ b/dev/modules/utilities/source.html @@ -806,7 +806,7 @@
      Documentation Version

      This module adds several functions for interactive source code inspection.

      -sympy.utilities.source.get_class(lookup_view)[source]
      +sympy.utilities.source.get_class(lookup_view)[source]

      Convert a string version of a class name to the object.

      For example, get_class(‘sympy.core.Basic’) will return class Basic located in module sympy.core

      @@ -814,7 +814,7 @@
      Documentation Version
      -sympy.utilities.source.get_mod_func(callback)[source]
      +sympy.utilities.source.get_mod_func(callback)[source]

      splits the string path to a class into a string path to the module and the name of the class.

      Examples

      diff --git a/dev/modules/utilities/timeutils.html b/dev/modules/utilities/timeutils.html index 8d44b8d03c2..c7658193312 100644 --- a/dev/modules/utilities/timeutils.html +++ b/dev/modules/utilities/timeutils.html @@ -806,7 +806,7 @@
      Documentation Version

      Simple tools for timing functions’ execution, when IPython is not available.

      -sympy.utilities.timeutils.timed(func, setup='pass', limit=None)[source]
      +sympy.utilities.timeutils.timed(func, setup='pass', limit=None)[source]

      Adaptively measure execution time of a function.

      diff --git a/dev/modules/vector/api/classes.html b/dev/modules/vector/api/classes.html index e6aedfdf75c..fe87f90fd6a 100644 --- a/dev/modules/vector/api/classes.html +++ b/dev/modules/vector/api/classes.html @@ -817,7 +817,7 @@

      Essential Classes in sympy.vector (docstrings)variable_names=None,

      -)[source] +)[source]

      Represents a coordinate system in 3-D space.

      @@ -837,7 +837,7 @@

      Essential Classes in sympy.vector (docstrings)transformation=None,

      -)[source] +)[source]

      The orientation/location parameters are necessary if this system is being defined at a certain orientation or location wrt another.

      @@ -888,7 +888,7 @@

      Essential Classes in sympy.vector (docstrings)vector_names=None,

      -)[source] +)[source]

      Returns a CoordSys3D which is connected to self by transformation.

      Parameters:
      @@ -932,7 +932,7 @@

      Essential Classes in sympy.vector (docstrings)variable_names=None,

      -)[source] +)[source]

      Returns a CoordSys3D with its origin located at the given position wrt this coordinate system’s origin.

      @@ -976,7 +976,7 @@

      Essential Classes in sympy.vector (docstrings)variable_names=None,

      -)[source] +)[source]

      Creates a new CoordSys3D oriented in the user-specified way with respect to this system.

      Please refer to the documentation of the orienter classes @@ -1056,7 +1056,7 @@

      Essential Classes in sympy.vector (docstrings)variable_names=None,

      -)[source] +)[source]

      Axis rotation is a rotation about an arbitrary axis by some angle. The angle is supplied as a SymPy expr scalar, and the axis is supplied as a Vector.

      @@ -1113,7 +1113,7 @@

      Essential Classes in sympy.vector (docstrings)variable_names=None,

      -)[source] +)[source]

      Body orientation takes this coordinate system through three successive simple rotations.

      Body fixed rotations include both Euler Angles and @@ -1193,7 +1193,7 @@

      Essential Classes in sympy.vector (docstrings)variable_names=None,

      -)[source] +)[source]

      Quaternion orientation orients the new CoordSys3D with Quaternions, defined as a finite rotation about lambda, a unit vector, by some amount theta.

      @@ -1252,7 +1252,7 @@

      Essential Classes in sympy.vector (docstrings)variable_names=None,

      -)[source] +)[source]

      Space rotation is similar to Body rotation, but the rotations are applied in the opposite order.

      @@ -1315,7 +1315,7 @@

      Essential Classes in sympy.vector (docstrings)
      -position_wrt(other)[source]
      +position_wrt(other)[source]

      Returns the position vector of the origin of this coordinate system with respect to another Point/CoordSys3D.

      @@ -1340,7 +1340,7 @@

      Essential Classes in sympy.vector (docstrings)
      -rotation_matrix(other)[source]
      +rotation_matrix(other)[source]

      Returns the direction cosine matrix(DCM), also known as the ‘rotation matrix’ of this coordinate system with respect to another system.

      @@ -1373,7 +1373,7 @@

      Essential Classes in sympy.vector (docstrings)
      -scalar_map(other)[source]
      +scalar_map(other)[source]

      Returns a dictionary which expresses the coordinate variables (base scalars) of this frame in terms of the variables of otherframe.

      @@ -1401,7 +1401,7 @@

      Essential Classes in sympy.vector (docstrings)
      -class sympy.vector.vector.Vector(*args)[source]
      +class sympy.vector.vector.Vector(*args)[source]

      Super class for all Vector classes. Ideally, neither this class nor any of its subclasses should be instantiated by the user.

      @@ -1423,7 +1423,7 @@

      Essential Classes in sympy.vector (docstrings)
      -cross(other)[source]
      +cross(other)[source]

      Returns the cross product of this Vector with another Vector or Dyadic instance. The cross product is a Vector, if ‘other’ is a Vector. If ‘other’ @@ -1455,7 +1455,7 @@

      Essential Classes in sympy.vector (docstrings)
      -dot(other)[source]
      +dot(other)[source]

      Returns the dot product of this Vector, either with another Vector, or a Dyadic, or a Del operator. If ‘other’ is a Vector, returns the dot product scalar (SymPy @@ -1495,7 +1495,7 @@

      Essential Classes in sympy.vector (docstrings)
      -equals(other)[source]
      +equals(other)[source]

      Check if self and other are identically equal vectors.

      Parameters:
      @@ -1555,19 +1555,19 @@

      Essential Classes in sympy.vector (docstrings)
      -magnitude()[source]
      +magnitude()[source]

      Returns the magnitude of this vector.

      -normalize()[source]
      +normalize()[source]

      Returns the normalized version of this vector.

      -outer(other)[source]
      +outer(other)[source]

      Returns the outer product of this vector with another, in the form of a Dyadic instance.

      @@ -1590,7 +1590,7 @@

      Essential Classes in sympy.vector (docstrings)
      -projection(other, scalar=False)[source]
      +projection(other, scalar=False)[source]

      Returns the vector or scalar projection of the ‘other’ on ‘self’.

      Examples

      >>> from sympy.vector.coordsysrect import CoordSys3D
      @@ -1608,7 +1608,7 @@ 

      Essential Classes in sympy.vector (docstrings)
      -separate()[source]
      +separate()[source]

      The constituents of this vector in different coordinate systems, as per its definition.

      Returns a dict mapping each CoordSys3D to the corresponding @@ -1626,7 +1626,7 @@

      Essential Classes in sympy.vector (docstrings)
      -to_matrix(system)[source]
      +to_matrix(system)[source]

      Returns the matrix form of this vector with respect to the specified coordinate system.

      @@ -1655,7 +1655,7 @@

      Essential Classes in sympy.vector (docstrings)
      -class sympy.vector.dyadic.Dyadic(*args)[source]
      +class sympy.vector.dyadic.Dyadic(*args)[source]

      Super class for all Dyadic-classes.

      References

      @@ -1679,7 +1679,7 @@

      Essential Classes in sympy.vector (docstrings)
      -cross(other)[source]
      +cross(other)[source]

      Returns the cross product between this Dyadic, and a Vector, as a Vector instance.

      @@ -1702,7 +1702,7 @@

      Essential Classes in sympy.vector (docstrings)
      -dot(other)[source]
      +dot(other)[source]

      Returns the dot product(also called inner product) of this Dyadic, with another Dyadic or Vector. If ‘other’ is a Dyadic, this returns a Dyadic. Else, it returns @@ -1730,7 +1730,7 @@

      Essential Classes in sympy.vector (docstrings)
      -to_matrix(system, second_system=None)[source]
      +to_matrix(system, second_system=None)[source]

      Returns the matrix form of the dyadic with respect to one or two coordinate systems.

      @@ -1774,12 +1774,12 @@

      Essential Classes in sympy.vector (docstrings)
      -class sympy.vector.deloperator.Del[source]
      +class sympy.vector.deloperator.Del[source]

      Represents the vector differential operator, usually represented in mathematical expressions as the ‘nabla’ symbol.

      -cross(vect, doit=False)[source]
      +cross(vect, doit=False)[source]

      Represents the cross product between this operator and a given vector - equal to the curl of the vector field.

      @@ -1812,7 +1812,7 @@

      Essential Classes in sympy.vector (docstrings)
      -dot(vect, doit=False)[source]
      +dot(vect, doit=False)[source]

      Represents the dot product between this operator and a given vector - equal to the divergence of the vector field.

      @@ -1844,7 +1844,7 @@

      Essential Classes in sympy.vector (docstrings)
      -gradient(scalar_field, doit=False)[source]
      +gradient(scalar_field, doit=False)[source]

      Returns the gradient of the given scalar field, as a Vector instance.

      @@ -1877,7 +1877,7 @@

      Essential Classes in sympy.vector (docstrings)
      -class sympy.vector.parametricregion.ParametricRegion(definition, *bounds)[source]
      +class sympy.vector.parametricregion.ParametricRegion(definition, *bounds)[source]

      Represents a parametric region in space.

      Parameters:
      @@ -1920,7 +1920,7 @@

      Essential Classes in sympy.vector (docstrings)
      -class sympy.vector.implicitregion.ImplicitRegion(variables, equation)[source]
      +class sympy.vector.implicitregion.ImplicitRegion(variables, equation)[source]

      Represents an implicit region in space.

      Parameters:
      @@ -1960,7 +1960,7 @@

      Essential Classes in sympy.vector (docstrings)
      -multiplicity(point)[source]
      +multiplicity(point)[source]

      Returns the multiplicity of a singular point on the region.

      A singular point (x,y) of region is said to be of multiplicity m if all the partial derivatives off to order m - 1 vanish there.

      @@ -1985,7 +1985,7 @@

      Essential Classes in sympy.vector (docstrings)reg_point=None,

      -)[source] +)[source]

      Returns the rational parametrization of implicit region.

      Examples

      >>> from sympy import Eq
      @@ -2036,7 +2036,7 @@ 

      Essential Classes in sympy.vector (docstrings)
      -regular_point()[source]
      +regular_point()[source]

      Returns a point on the implicit region.

      Examples

      >>> from sympy.abc import x, y, z
      @@ -2062,7 +2062,7 @@ 

      Essential Classes in sympy.vector (docstrings)
      -singular_points()[source]
      +singular_points()[source]

      Returns a set of singular points of the region.

      The singular points are those points on the region where all partial derivatives vanish.

      @@ -2080,7 +2080,7 @@

      Essential Classes in sympy.vector (docstrings)
      -class sympy.vector.integrals.ParametricIntegral(field, parametricregion)[source]
      +class sympy.vector.integrals.ParametricIntegral(field, parametricregion)[source]

      Represents integral of a scalar or vector field over a Parametric Region

      Examples

      diff --git a/dev/modules/vector/api/orienterclasses.html b/dev/modules/vector/api/orienterclasses.html index 757c0678dcf..8899e4a0f80 100644 --- a/dev/modules/vector/api/orienterclasses.html +++ b/dev/modules/vector/api/orienterclasses.html @@ -805,11 +805,11 @@
      Documentation Version

      Orienter classes (docstrings)

      -class sympy.vector.orienters.Orienter(*args)[source]
      +class sympy.vector.orienters.Orienter(*args)[source]

      Super-class for all orienter classes.

      -rotation_matrix()[source]
      +rotation_matrix()[source]

      The rotation matrix corresponding to this orienter instance.

      @@ -818,11 +818,11 @@

      Orienter classes (docstrings)
      -class sympy.vector.orienters.AxisOrienter(angle, axis)[source]
      +class sympy.vector.orienters.AxisOrienter(angle, axis)[source]

      Class to denote an axis orienter.

      -__init__(angle, axis)[source]
      +__init__(angle, axis)[source]

      Axis rotation is a rotation about an arbitrary axis by some angle. The angle is supplied as a SymPy expr scalar, and the axis is supplied as a Vector.

      @@ -852,7 +852,7 @@

      Orienter classes (docstrings)
      -rotation_matrix(system)[source]
      +rotation_matrix(system)[source]

      The rotation matrix corresponding to this orienter instance.

      @@ -870,7 +870,7 @@

      Orienter classes (docstrings)
      -class sympy.vector.orienters.BodyOrienter(angle1, angle2, angle3, rot_order)[source]
      +class sympy.vector.orienters.BodyOrienter(angle1, angle2, angle3, rot_order)[source]

      Class to denote a body-orienter.

      @@ -883,7 +883,7 @@

      Orienter classes (docstrings)rot_order,

      -)[source] +)[source]

      Body orientation takes this coordinate system through three successive simple rotations.

      Body fixed rotations include both Euler Angles and @@ -941,7 +941,7 @@

      Orienter classes (docstrings)
      -class sympy.vector.orienters.SpaceOrienter(angle1, angle2, angle3, rot_order)[source]
      +class sympy.vector.orienters.SpaceOrienter(angle1, angle2, angle3, rot_order)[source]

      Class to denote a space-orienter.

      @@ -954,7 +954,7 @@

      Orienter classes (docstrings)rot_order,

      -)[source] +)[source]

      Space rotation is similar to Body rotation, but the rotations are applied in the opposite order.

      @@ -1008,7 +1008,7 @@

      Orienter classes (docstrings)
      -class sympy.vector.orienters.QuaternionOrienter(q0, q1, q2, q3)[source]
      +class sympy.vector.orienters.QuaternionOrienter(q0, q1, q2, q3)[source]

      Class to denote a quaternion-orienter.

      @@ -1021,7 +1021,7 @@

      Orienter classes (docstrings)rot_order,

      -)[source] +)[source]

      Quaternion orientation orients the new CoordSys3D with Quaternions, defined as a finite rotation about lambda, a unit vector, by some amount theta.

      diff --git a/dev/modules/vector/api/vectorfunctions.html b/dev/modules/vector/api/vectorfunctions.html index 84db7d8303e..2064e6bbf9b 100644 --- a/dev/modules/vector/api/vectorfunctions.html +++ b/dev/modules/vector/api/vectorfunctions.html @@ -805,7 +805,7 @@
      Documentation Version

      Essential Functions in sympy.vector (docstrings)

      -sympy.vector.matrix_to_vector(matrix, system)[source]
      +sympy.vector.matrix_to_vector(matrix, system)[source]

      Converts a vector in matrix form to a Vector instance.

      It is assumed that the elements of the Matrix represent the measure numbers of the components of the vector along basis @@ -847,7 +847,7 @@

      Essential Functions in sympy.vector (docstrings)variables=False,

      -)[source] +)[source]

      Global function for ‘express’ functionality.

      Re-expresses a Vector, Dyadic or scalar(sympyfiable) in the given coordinate system.

      @@ -897,7 +897,7 @@

      Essential Functions in sympy.vector (docstrings)
      -sympy.vector.curl(vect, doit=True)[source]
      +sympy.vector.curl(vect, doit=True)[source]

      Returns the curl of a vector field computed wrt the base scalars of the given coordinate system.

      @@ -929,7 +929,7 @@

      Essential Functions in sympy.vector (docstrings)
      -sympy.vector.divergence(vect, doit=True)[source]
      +sympy.vector.divergence(vect, doit=True)[source]

      Returns the divergence of a vector field computed wrt the base scalars of the given coordinate system.

      @@ -963,7 +963,7 @@

      Essential Functions in sympy.vector (docstrings)
      -sympy.vector.gradient(scalar_field, doit=True)[source]
      +sympy.vector.gradient(scalar_field, doit=True)[source]

      Returns the vector gradient of a scalar field computed wrt the base scalars of the given coordinate system.

      @@ -995,7 +995,7 @@

      Essential Functions in sympy.vector (docstrings)
      -sympy.vector.is_conservative(field)[source]
      +sympy.vector.is_conservative(field)[source]

      Checks if a field is conservative.

      Parameters:
      @@ -1019,7 +1019,7 @@

      Essential Functions in sympy.vector (docstrings)
      -sympy.vector.is_solenoidal(field)[source]
      +sympy.vector.is_solenoidal(field)[source]

      Checks if a field is solenoidal.

      Parameters:
      @@ -1043,7 +1043,7 @@

      Essential Functions in sympy.vector (docstrings)
      -sympy.vector.scalar_potential(field, coord_sys)[source]
      +sympy.vector.scalar_potential(field, coord_sys)[source]

      Returns the scalar potential function of a field in a given coordinate system (without the added integration constant).

      @@ -1084,7 +1084,7 @@

      Essential Functions in sympy.vector (docstrings)point2,

      -)[source] +)[source]

      Returns the scalar potential difference between two points in a certain coordinate system, wrt a given field.

      If a scalar field is provided, its values at the two points are @@ -1130,7 +1130,7 @@

      Essential Functions in sympy.vector (docstrings)
      -sympy.vector.integrals.vector_integrate(field, *region)[source]
      +sympy.vector.integrals.vector_integrate(field, *region)[source]

      Compute the integral of a vector/scalar field over a a region or a set of parameters.

      Examples