diff --git a/Examples/fit51_Basic/basic_fitting_tutorial.py b/Examples/fit51_Basic/basic_fitting_tutorial.py index 0ae9626101ea467aed45b96e75b3de5804d3bd47..f87b6f6cc0a6f640d87fca131e63d6a14ea1919b 100644 --- a/Examples/fit51_Basic/basic_fitting_tutorial.py +++ b/Examples/fit51_Basic/basic_fitting_tutorial.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: 4 parameters fit for mixture of cylinders and prisms on top of substrate. diff --git a/Examples/fit51_Basic/consecutive_fitting.py b/Examples/fit51_Basic/consecutive_fitting.py index 59193cf7f5d9f85db60fd8cfa022968fd4b899ee..8b6a79b248b1781130fb22dc37246ec0d6a1e783 100644 --- a/Examples/fit51_Basic/consecutive_fitting.py +++ b/Examples/fit51_Basic/consecutive_fitting.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: running one fit after another using different minimizers. diff --git a/Examples/fit51_Basic/minimal_fit_example.py b/Examples/fit51_Basic/minimal_fit_example.py index cf2883a060db711b0cafdf240710c6b91e9b1429..4cac7fe64a2a24c085f41de3f0f56c2ad92eae82 100644 --- a/Examples/fit51_Basic/minimal_fit_example.py +++ b/Examples/fit51_Basic/minimal_fit_example.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Minimal working fit examples: finds radius of sphere in Born approximation. """ diff --git a/Examples/fit51_Basic/minimizer_settings.py b/Examples/fit51_Basic/minimizer_settings.py index dfffad0b1fa9b38439e42f4eaa676dcf30e52d3d..469cd26e36b1a4f1d8cb84725ac657ee0a7943b9 100644 --- a/Examples/fit51_Basic/minimizer_settings.py +++ b/Examples/fit51_Basic/minimizer_settings.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: running same fit using various minimizer and their settings. """ diff --git a/Examples/fit52_Advanced/find_background.py b/Examples/fit52_Advanced/find_background.py index 001f8382bcea36b6a57cb9741f674a14f99b3eab..5b32f9d604aca2e0aef1dabe118ebb52b8c80591 100644 --- a/Examples/fit52_Advanced/find_background.py +++ b/Examples/fit52_Advanced/find_background.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: looking for background and scale factors. diff --git a/Examples/fit52_Advanced/fit_along_slices.py b/Examples/fit52_Advanced/fit_along_slices.py index 52e1fe7ad1c603bd60b9dd948aefba17858cb892..bd8d595d331ea7789d82e62b6bbdb0c9e5565fca 100644 --- a/Examples/fit52_Advanced/fit_along_slices.py +++ b/Examples/fit52_Advanced/fit_along_slices.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: fit along slices """ diff --git a/Examples/fit52_Advanced/fit_with_masks.py b/Examples/fit52_Advanced/fit_with_masks.py index 6c00d5a7a6278801a95f1042236a16367704801e..eae6aeaa3824f11773fdd484f61d8489541310e4 100644 --- a/Examples/fit52_Advanced/fit_with_masks.py +++ b/Examples/fit52_Advanced/fit_with_masks.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: fit with masks """ diff --git a/Examples/fit52_Advanced/multiple_datasets.py b/Examples/fit52_Advanced/multiple_datasets.py index 96a02b7ca043abca234a150a89ee8dcfb1c37abd..de24da26ecf3ab88bb83c4d6f4faf2a6057323d4 100644 --- a/Examples/fit52_Advanced/multiple_datasets.py +++ b/Examples/fit52_Advanced/multiple_datasets.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting example: simultaneous fit of two datasets """ diff --git a/Examples/fit53_CustomObjective/custom_objective_function.py b/Examples/fit53_CustomObjective/custom_objective_function.py index c9d41a5d81fd886efbbdae5688dc8b6e8ce3ac9c..1690de82ffa49a72d390d9b5b71b3c58083e39e5 100644 --- a/Examples/fit53_CustomObjective/custom_objective_function.py +++ b/Examples/fit53_CustomObjective/custom_objective_function.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Using custom objective function to fit GISAS data. diff --git a/Examples/fit54_ExternalMinimizer/lmfit_basics.py b/Examples/fit54_ExternalMinimizer/lmfit_basics.py index a2bd371deff962842473bdd2d430269a803c5492..2cc226890c9a8b084a8b921c6922020df0302801 100644 --- a/Examples/fit54_ExternalMinimizer/lmfit_basics.py +++ b/Examples/fit54_ExternalMinimizer/lmfit_basics.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ External minimize: using lmfit minimizers for BornAgain fits. """ diff --git a/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py b/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py index 2c78516ec5e041bc49092778dfcee396a8470ff4..c8414a9b13db8c4469176ede1a25768a6f415417 100644 --- a/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py +++ b/Examples/fit54_ExternalMinimizer/lmfit_with_plotting.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ External minimize: using lmfit minimizers for BornAgain fits. Fit progress is plotted using lmfit iteration calbback function. diff --git a/Examples/fit55_SpecularIntro/FitSpecularBasics.py b/Examples/fit55_SpecularIntro/FitSpecularBasics.py index 0a6b67271af9fe6a6eade01e5a2757bfbd3a28a4..f914dcbb25d54f86a0bf01011dc682079aad6de1 100644 --- a/Examples/fit55_SpecularIntro/FitSpecularBasics.py +++ b/Examples/fit55_SpecularIntro/FitSpecularBasics.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example demonstrates how to fit specular data. Our sample represents twenty interchanging layers of Ti and Ni. We will fit diff --git a/Examples/fit55_SpecularIntro/FitWithUncertainties.py b/Examples/fit55_SpecularIntro/FitWithUncertainties.py index 56b19c690fc3dced857d7c0130ddf56d02e329c2..416685355b4d53bde4fc0b73d0717c9c484fed6f 100644 --- a/Examples/fit55_SpecularIntro/FitWithUncertainties.py +++ b/Examples/fit55_SpecularIntro/FitWithUncertainties.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example demonstrates how to fit specular data. Our sample represents twenty interchanging layers of Ti and Ni. We will fit diff --git a/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py b/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py index 970338e1de1c273111fb3925eb0aa6cf635ab805..5262ea8031c2183254eb0c76f0a3bf3a23a62aa5 100644 --- a/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py +++ b/Examples/fit55_SpecularIntro/PolarizedSpinAsymmetryFit.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This fitting and simulation example demonstrates how to replicate the fitting example "Magnetically Dead Layers in Spinel Films" diff --git a/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py b/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py index d0b061bdffe15171b95d44837b3320e07470a206..7c7aabe6ae7ab4d827815c5b39327f4b4a3d37bc 100644 --- a/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py +++ b/Examples/fit55_SpecularIntro/RealLifeReflectometryFitting.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Real life example: Fitting data from an X-ray reflectometer diff --git a/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py b/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py index e5977866c950d912380588ca9b2ed5592ae4ca31..d6ead29c29f6789ffb3debaf1dad62a3b25ccc50 100644 --- a/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py +++ b/Examples/fit56_SpecularAdvanced/Honeycomb_fit.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This example demonstrates how to fit a complex experimental setup using BornAgain. It is based on real data published in https://doi.org/10.1002/advs.201700856 diff --git a/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py b/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py index 1eb2a1f861bc22fa4bc4ecb7c3c0d6d631ed5a74..e06ddd9c53841c9c0b4c0b0f1697da99ef91034a 100644 --- a/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py +++ b/Examples/fit56_SpecularAdvanced/Pt_layer_fit.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This example demonstrates how to fit actual experimental data by M. Fitzsimmons et al. that is published in diff --git a/Examples/fit61_Galaxi/fit_galaxi_data.py b/Examples/fit61_Galaxi/fit_galaxi_data.py index fb7d6fcd69ea4e223e591fa22a3a0bdb4bcbf4df..faeb0723acdec4dfb89a84d0cafbe2c0339c7a34 100644 --- a/Examples/fit61_Galaxi/fit_galaxi_data.py +++ b/Examples/fit61_Galaxi/fit_galaxi_data.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Fitting experimental data: spherical nanoparticles with size distribution in 3 layers system (experiment at GALAXI). diff --git a/Examples/fit61_Galaxi/sample_builder.py b/Examples/fit61_Galaxi/sample_builder.py index 3ada2bdcb3f945404e6d115e59b46486b2334893..b9a919eca84d7356f3a46ac025de900815a3233f 100644 --- a/Examples/fit61_Galaxi/sample_builder.py +++ b/Examples/fit61_Galaxi/sample_builder.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ 3 layers system (substrate, teflon, air). Vacuum layer is populated with spheres with size distribution. diff --git a/Examples/scatter2d/ApproximationDA.py b/Examples/scatter2d/ApproximationDA.py index f31561b356bffb31782571c09704ffbfcbfb63d2..6fbd99ed31db0622b4bbb707a9749ac79ec0d45e 100644 --- a/Examples/scatter2d/ApproximationDA.py +++ b/Examples/scatter2d/ApproximationDA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders of two different sizes in Decoupling Approximation """ diff --git a/Examples/scatter2d/ApproximationLMA.py b/Examples/scatter2d/ApproximationLMA.py index 5ac53ba473a166d3823b154fecd8ddb0d895eea9..ee4dc132730efb5a088929f1c366655d937f1695 100644 --- a/Examples/scatter2d/ApproximationLMA.py +++ b/Examples/scatter2d/ApproximationLMA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders of two different sizes in Local Monodisperse Approximation """ diff --git a/Examples/scatter2d/ApproximationSSCA.py b/Examples/scatter2d/ApproximationSSCA.py index 0f755324a38bafb5874541305bcb333828cbf31e..b2f8a8e5c82a227060fd59c256e680ee9a97282e 100644 --- a/Examples/scatter2d/ApproximationSSCA.py +++ b/Examples/scatter2d/ApproximationSSCA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders of two different sizes in Size-Spacing Coupling Approximation """ diff --git a/Examples/scatter2d/BeamDivergence.py b/Examples/scatter2d/BeamDivergence.py index 7427e5be5d0fc5e5bb3374f038d40d0cb2489e2f..9045ea1767db48df887a92acff0bd64000ad163d 100644 --- a/Examples/scatter2d/BeamDivergence.py +++ b/Examples/scatter2d/BeamDivergence.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA with beam divergence """ diff --git a/Examples/scatter2d/BiMaterialCylinders.py b/Examples/scatter2d/BiMaterialCylinders.py index 984d9b730d95c8e87db91869170ef7f3e54c7022..275f56f833f60fa30bad6252ee45bbc02dea58be 100644 --- a/Examples/scatter2d/BiMaterialCylinders.py +++ b/Examples/scatter2d/BiMaterialCylinders.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylindrical particle made from two materials. Particle crosses air/substrate interface. diff --git a/Examples/scatter2d/BoxesWithSpecularPeak.py b/Examples/scatter2d/BoxesWithSpecularPeak.py index 045e2d774ee2328066c0ad6008b23f22aebdb138..aab73f75c80e86c852388fe8b65ba8170e5372c8 100644 --- a/Examples/scatter2d/BoxesWithSpecularPeak.py +++ b/Examples/scatter2d/BoxesWithSpecularPeak.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Square lattice of boxes on substrate (including the specular peak) """ diff --git a/Examples/scatter2d/BuriedParticles.py b/Examples/scatter2d/BuriedParticles.py index 8f632ef8f1f39e02c899b54e38eb02628a969355..806d1d379f675d92022c63901f98e5b9004bfa01 100644 --- a/Examples/scatter2d/BuriedParticles.py +++ b/Examples/scatter2d/BuriedParticles.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Spherical particles embedded in the middle of the layer on top of substrate. """ diff --git a/Examples/scatter2d/ConstantBackground.py b/Examples/scatter2d/ConstantBackground.py index 46211573d776e676f8e30dcd8b3a747618e28ee1..9fbb322fd877f944e09de5eaa5be108183ed666e 100644 --- a/Examples/scatter2d/ConstantBackground.py +++ b/Examples/scatter2d/ConstantBackground.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA with constant background """ diff --git a/Examples/scatter2d/CoreShellNanoparticles.py b/Examples/scatter2d/CoreShellNanoparticles.py index d47fa529f1cfa489a9e044cc487731aacc414b2c..463858ed9d3db12b660226550db102f778fcceff 100644 --- a/Examples/scatter2d/CoreShellNanoparticles.py +++ b/Examples/scatter2d/CoreShellNanoparticles.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Core shell nanoparticles """ diff --git a/Examples/scatter2d/CorrelatedRoughness.py b/Examples/scatter2d/CorrelatedRoughness.py index 6e844179cce9ccd3b3c62c565c5be096b54ba74e..c92cb436be1143128face845684b4488462c1019 100644 --- a/Examples/scatter2d/CorrelatedRoughness.py +++ b/Examples/scatter2d/CorrelatedRoughness.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ MultiLayer with correlated roughness """ diff --git a/Examples/scatter2d/CosineRipplesAtRectLattice.py b/Examples/scatter2d/CosineRipplesAtRectLattice.py index 741ba3e5adaa0662908dff3f8cb8df6dc1ae8aab..d5bf586e48bbb50074b8c8d086e9b9280ffc85be 100644 --- a/Examples/scatter2d/CosineRipplesAtRectLattice.py +++ b/Examples/scatter2d/CosineRipplesAtRectLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cosine ripple on a 2D lattice """ diff --git a/Examples/scatter2d/CylindersAndPrisms.py b/Examples/scatter2d/CylindersAndPrisms.py index a14fcef883771921506c6c05ae77d14aca533067..7db298a07b4139da5554464fb521c32d28255f6d 100644 --- a/Examples/scatter2d/CylindersAndPrisms.py +++ b/Examples/scatter2d/CylindersAndPrisms.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Mixture of cylinders and prisms without interference """ diff --git a/Examples/scatter2d/CylindersInAverageLayer.py b/Examples/scatter2d/CylindersInAverageLayer.py index 410a434a9cf054aab02ef2faf0ba2b80e622ea89..55c7e31fa33f1d0d9594bb717086da4b28a1d087 100644 --- a/Examples/scatter2d/CylindersInAverageLayer.py +++ b/Examples/scatter2d/CylindersInAverageLayer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Square lattice of cylinders inside finite layer with usage of average material """ diff --git a/Examples/scatter2d/CylindersInBA.py b/Examples/scatter2d/CylindersInBA.py index 64d5c7b3711599ba9927ca61b24d2b10f857e2d5..27be2a5261ba6ed4452b1be1effc01ff0b63a9d3 100644 --- a/Examples/scatter2d/CylindersInBA.py +++ b/Examples/scatter2d/CylindersInBA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in Born approximation """ diff --git a/Examples/scatter2d/CylindersInDWBA.py b/Examples/scatter2d/CylindersInDWBA.py index 84360e98e9f6319bb34fa51670f4724236f55477..a9b18ba2e49565ab867043889eff241db254468e 100644 --- a/Examples/scatter2d/CylindersInDWBA.py +++ b/Examples/scatter2d/CylindersInDWBA.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA """ diff --git a/Examples/scatter2d/CylindersWithSizeDistribution.py b/Examples/scatter2d/CylindersWithSizeDistribution.py index 398dc1e219d1d6af923e4c102edd2e17e549ba3b..fcc66e4795e64bdb8466e6b91031b349507e09bc 100644 --- a/Examples/scatter2d/CylindersWithSizeDistribution.py +++ b/Examples/scatter2d/CylindersWithSizeDistribution.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders with size distribution """ diff --git a/Examples/scatter2d/DetectorResolutionFunction.py b/Examples/scatter2d/DetectorResolutionFunction.py index efe1718d899524f35949d1dcccbfab42120debf6..8eeaf26f0005fbe750425a249ecf89094af8dde1 100644 --- a/Examples/scatter2d/DetectorResolutionFunction.py +++ b/Examples/scatter2d/DetectorResolutionFunction.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinder form factor in DWBA with detector resolution function applied """ diff --git a/Examples/scatter2d/HalfSpheresInAverageTopLayer.py b/Examples/scatter2d/HalfSpheresInAverageTopLayer.py index dd82a0df3f96746f6fbc7b57d582418ba3d57649..d3328cb59461c6b7edef033a096477b52f208ae0 100644 --- a/Examples/scatter2d/HalfSpheresInAverageTopLayer.py +++ b/Examples/scatter2d/HalfSpheresInAverageTopLayer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Square lattice of half spheres on substrate with usage of average material and slicing diff --git a/Examples/scatter2d/HexagonalLatticesWithBasis.py b/Examples/scatter2d/HexagonalLatticesWithBasis.py index 9f83af14f31ec0f49c1b655fc9ddc331df04ab47..95335e8009aa994a2d35bcb2eefdd2e3026118c3 100644 --- a/Examples/scatter2d/HexagonalLatticesWithBasis.py +++ b/Examples/scatter2d/HexagonalLatticesWithBasis.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Spheres on two hexagonal close packed layers """ diff --git a/Examples/scatter2d/Interference1DRadialParaCrystal.py b/Examples/scatter2d/Interference1DRadialParaCrystal.py index 2b0033bfffe9bc7b6e57057a1509484985856656..0915d819a30651d32d930edfc41ce38ad180b6d2 100644 --- a/Examples/scatter2d/Interference1DRadialParaCrystal.py +++ b/Examples/scatter2d/Interference1DRadialParaCrystal.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ radial paracrystal """ diff --git a/Examples/scatter2d/Interference2DCenteredSquareLattice.py b/Examples/scatter2d/Interference2DCenteredSquareLattice.py index ba72804532fb5cc6b775e7dd350635fe4e26c3e2..1ce18932a8c6ac71e250f1fec8af079ed260643a 100644 --- a/Examples/scatter2d/Interference2DCenteredSquareLattice.py +++ b/Examples/scatter2d/Interference2DCenteredSquareLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ 2D lattice with disorder, centered square lattice """ diff --git a/Examples/scatter2d/Interference2DLatticeSumOfRotated.py b/Examples/scatter2d/Interference2DLatticeSumOfRotated.py index f64b969c6134804eb5c272e41423c0a6663c6288..9866a4a53734d3f7191663f0fcc4534ac84d82a5 100644 --- a/Examples/scatter2d/Interference2DLatticeSumOfRotated.py +++ b/Examples/scatter2d/Interference2DLatticeSumOfRotated.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 import bornagain as ba from bornagain import deg, nm diff --git a/Examples/scatter2d/Interference2DParaCrystal.py b/Examples/scatter2d/Interference2DParaCrystal.py index 90bb8b7f7f8c3ab13abb59d95d67ef96a59b9111..77d5ba2efce7fee36f9ad10adce95ceaea8b3d34 100644 --- a/Examples/scatter2d/Interference2DParaCrystal.py +++ b/Examples/scatter2d/Interference2DParaCrystal.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ 2D paracrystal """ diff --git a/Examples/scatter2d/Interference2DRotatedSquareLattice.py b/Examples/scatter2d/Interference2DRotatedSquareLattice.py index 22ec4a4222c7e91c521fb2fee2dcd1afea033e07..09595e8a75f29b3c346abcc635699c75dcad1bd5 100644 --- a/Examples/scatter2d/Interference2DRotatedSquareLattice.py +++ b/Examples/scatter2d/Interference2DRotatedSquareLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders on a rotated 2D lattice """ diff --git a/Examples/scatter2d/Interference2DSquareFiniteLattice.py b/Examples/scatter2d/Interference2DSquareFiniteLattice.py index 32f6f7c3be1e320181b698ec0eb5a8fc3d215ebc..aa6831b1c70e5483b069f14d84c435e8eae5080c 100644 --- a/Examples/scatter2d/Interference2DSquareFiniteLattice.py +++ b/Examples/scatter2d/Interference2DSquareFiniteLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders on a 2D square lattice """ diff --git a/Examples/scatter2d/Interference2DSquareLattice.py b/Examples/scatter2d/Interference2DSquareLattice.py index b843d8801851be5bae30c4fd93a7409f24730349..b8c679c8ebc58156d614fec10d760392f1bcd38d 100644 --- a/Examples/scatter2d/Interference2DSquareLattice.py +++ b/Examples/scatter2d/Interference2DSquareLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylinders on a 2D square lattice """ diff --git a/Examples/scatter2d/MagneticSpheres.py b/Examples/scatter2d/MagneticSpheres.py index ab0431edaf5065243d8156154a51f5f68630ec7e..d8389c08fcc1d38fc6ee2d8a31a3ce1147b318f8 100644 --- a/Examples/scatter2d/MagneticSpheres.py +++ b/Examples/scatter2d/MagneticSpheres.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation demo: magnetic spheres in substrate """ diff --git a/Examples/scatter2d/MesoCrystal.py b/Examples/scatter2d/MesoCrystal.py index 149c9c171cdb3d83862111a04e1ccc6d8ac5f047..fa7a0cbca3e5494f70431ac1fdf186df92347547 100644 --- a/Examples/scatter2d/MesoCrystal.py +++ b/Examples/scatter2d/MesoCrystal.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Cylindrical mesocrystal on a substrate """ diff --git a/Examples/scatter2d/ParticlesCrossingInterface.py b/Examples/scatter2d/ParticlesCrossingInterface.py index ed344c9cfa893c763f456f696230034a47d4a2b1..bf4d512400bdc405b4b993b11acf2957a731e646 100644 --- a/Examples/scatter2d/ParticlesCrossingInterface.py +++ b/Examples/scatter2d/ParticlesCrossingInterface.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This example demonstrates new experimental feature of release-1.8.0: particles can now cross interfaces. diff --git a/Examples/scatter2d/RectangularGrating.py b/Examples/scatter2d/RectangularGrating.py index 72b827ef2ef93eb77d1fc6c60035d8d7fc350236..640b24778ab0d8467f25808062d3a38584dbfb1b 100644 --- a/Examples/scatter2d/RectangularGrating.py +++ b/Examples/scatter2d/RectangularGrating.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/scatter2d/RotatedPyramids.py b/Examples/scatter2d/RotatedPyramids.py index 55e7822bca7ca0f4fa2f4357afb3ae8ef048ed06..477807ae07a4a1a5d5e922335567559adfe22f48 100644 --- a/Examples/scatter2d/RotatedPyramids.py +++ b/Examples/scatter2d/RotatedPyramids.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Rotated pyramids on top of substrate """ diff --git a/Examples/scatter2d/SpheresAtHexLattice.py b/Examples/scatter2d/SpheresAtHexLattice.py index 3b3ca8c0d9e8e56b0ca3bf729959f5a3e457eac3..a3e8f359a659c2f3e2260d5db74f454d6ceadb5f 100644 --- a/Examples/scatter2d/SpheresAtHexLattice.py +++ b/Examples/scatter2d/SpheresAtHexLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Spheres on a hexagonal lattice """ diff --git a/Examples/scatter2d/TriangularRipple.py b/Examples/scatter2d/TriangularRipple.py index df049044dfbb8484276840c91236d0b0aa0edec9..6f7dddc73f6d0c6e578b948c8abc72000e5f5abc 100644 --- a/Examples/scatter2d/TriangularRipple.py +++ b/Examples/scatter2d/TriangularRipple.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Sample from the article D. Babonneau et. al., Phys. Rev. B 85, 235415, 2012 (Fig.3) """ diff --git a/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py b/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py index b7bdd862d8df748c38e43a78beee4981dc8b9da2..e3089e34e46825f1b1911f5c328a730ca98bb63c 100644 --- a/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py +++ b/Examples/scatter2d/TwoTypesOfCylindersWithSizeDistribution.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Mixture cylinder particles with different size distribution """ diff --git a/Examples/specular/BasicSpecularSimulation.py b/Examples/specular/BasicSpecularSimulation.py index 283e14ab641d8099e54c194c6b16ad85d009cec3..491a1e53820da3e3f6bd3002db63afd7a1af2249 100644 --- a/Examples/specular/BasicSpecularSimulation.py +++ b/Examples/specular/BasicSpecularSimulation.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Basic example of specular simulation with BornAgain. diff --git a/Examples/specular/BeamAngularDivergence.py b/Examples/specular/BeamAngularDivergence.py index a8db4eb7ac477806ec8611fee1563ac8aac053d2..27f9d9c4e63b8610d6e2a20790d3f42975b6b24c 100644 --- a/Examples/specular/BeamAngularDivergence.py +++ b/Examples/specular/BeamAngularDivergence.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of taking into account beam angular divergence and beam footprint correction in reflectometry calculations diff --git a/Examples/specular/BeamFullDivergence.py b/Examples/specular/BeamFullDivergence.py index 21d34bd095620848e64de7288049447290ebcfde..2aac626629cb72ae1390789a1f2d1a0fd5eec631 100644 --- a/Examples/specular/BeamFullDivergence.py +++ b/Examples/specular/BeamFullDivergence.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of taking into account beam angular and wavelength divergence in reflectometry calculations with BornAgain. diff --git a/Examples/specular/TOFRWithResolution.py b/Examples/specular/TOFRWithResolution.py index b8a5ed340969069131e2437a233eaadd66c92bf9..f7d3783571cf8373fce71e153eca66c5237e7186 100644 --- a/Examples/specular/TOFRWithResolution.py +++ b/Examples/specular/TOFRWithResolution.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of defining reflectometry instrument for time of flight experiment. In this example diff --git a/Examples/specular/TimeOfFlightReflectometry.py b/Examples/specular/TimeOfFlightReflectometry.py index 02709aa98b695a2d0dd92d99c6701c1b925deda3..d81eace85f511678342a8e38410747520f889d59 100644 --- a/Examples/specular/TimeOfFlightReflectometry.py +++ b/Examples/specular/TimeOfFlightReflectometry.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of defining reflectometry instrument for time of flight experiment. In this example diff --git a/Examples/varia/AccessingSimulationResults.py b/Examples/varia/AccessingSimulationResults.py index 068b7ba7c1a7f324d58cd3720ba4d96fc7f8b11a..b99f011444883dd83c53cc6668ee137002566024 100644 --- a/Examples/varia/AccessingSimulationResults.py +++ b/Examples/varia/AccessingSimulationResults.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Extended example for simulation results treatment (cropping, slicing, exporting) The standard "Cylinders in DWBA" sample is used to setup the simulation. diff --git a/Examples/varia/AllFormFactorsAvailable.py b/Examples/varia/AllFormFactorsAvailable.py index e412aad4baa375d3081d14b614cf34ca7cc56533..b7ecd5bd3fef118fe9a939b4526d187c997d06cd 100644 --- a/Examples/varia/AllFormFactorsAvailable.py +++ b/Examples/varia/AllFormFactorsAvailable.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ All form factors available in BornAgain in the Born Approximation """ diff --git a/Examples/varia/AxesInDifferentUnits.py b/Examples/varia/AxesInDifferentUnits.py index e657d8f701de1b13d8771e1eda897b01c82d9c62..09d0919d796732c9ca8f0ed598493542f45028c8 100644 --- a/Examples/varia/AxesInDifferentUnits.py +++ b/Examples/varia/AxesInDifferentUnits.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ In this example we demonstrate how to plot simulation results with axes in different units (nbins, mm, degs and QyQz). diff --git a/Examples/varia/BasicPolarizedReflectometry.py b/Examples/varia/BasicPolarizedReflectometry.py index 11c3d85fd11526b33cba6544dc16cf4435fa7fa6..1783e0672aacdb044ddec1152f42e0363cdce778 100644 --- a/Examples/varia/BasicPolarizedReflectometry.py +++ b/Examples/varia/BasicPolarizedReflectometry.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of computing reflectivity on a magnetized sample. diff --git a/Examples/varia/CustomFormFactor.py b/Examples/varia/CustomFormFactor.py index 5e416d89f1744ad5c64482d6ad4c25d9ad1e66fb..2f962490866ed49d3c75595893f008227efe5a9d 100644 --- a/Examples/varia/CustomFormFactor.py +++ b/Examples/varia/CustomFormFactor.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Custom form factor in DWBA. """ diff --git a/Examples/varia/DepthProbe.py b/Examples/varia/DepthProbe.py index 284d721c24780479e939950455cf0e5a7a99b087..c954d3dc36b65319c1f8d84387d606a2bf8783ea 100644 --- a/Examples/varia/DepthProbe.py +++ b/Examples/varia/DepthProbe.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Basic example of depth-probe simulation with BornAgain. Sample structure: diff --git a/Examples/varia/FindPeaks.py b/Examples/varia/FindPeaks.py index a0d8d9ea89240b45637ccc3c649501ff8cf69a48..e312c82980f9c971f2d5e730780a8848120a51da 100644 --- a/Examples/varia/FindPeaks.py +++ b/Examples/varia/FindPeaks.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/varia/FootprintCorrection.py b/Examples/varia/FootprintCorrection.py index 17e911b84dac2f5e11f623a7b64b763fc1ae83cc..12d46ac9471a5a27090fd1e02f115f314adbccba 100644 --- a/Examples/varia/FootprintCorrection.py +++ b/Examples/varia/FootprintCorrection.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Specular simulation with a footprint correction for a square beam diff --git a/Examples/varia/GratingMC.py b/Examples/varia/GratingMC.py index 87fd859ebf521fb40d3b4956a27d8b607c4fafdc..d2cee7b4c29ae1e94674b44510a2a2434b2ad406 100644 --- a/Examples/varia/GratingMC.py +++ b/Examples/varia/GratingMC.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/varia/Interference1DLattice.py b/Examples/varia/Interference1DLattice.py index 9f0d93109e50fbac1654bbb2788484c6274139a2..ee0e49a2b3a22594a4ea95e9c9e258268dd8f3e6 100644 --- a/Examples/varia/Interference1DLattice.py +++ b/Examples/varia/Interference1DLattice.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation of grating using very long boxes and 1D lattice. Monte-carlo integration is used to get rid of diff --git a/Examples/varia/LargeParticlesFormFactor.py b/Examples/varia/LargeParticlesFormFactor.py index ab986f06297c6c97071a9e6704f3594799133ec6..219737a9900f0d62a2234f7ed0b2326a84371e64 100644 --- a/Examples/varia/LargeParticlesFormFactor.py +++ b/Examples/varia/LargeParticlesFormFactor.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Large cylinders in DWBA. diff --git a/Examples/varia/MaterialProfile.py b/Examples/varia/MaterialProfile.py index 423a7cbfeda091d2dc37ef95fcd7c95d2831c776..82bd3391d5b824983bdf72d55146b16b8c279868 100644 --- a/Examples/varia/MaterialProfile.py +++ b/Examples/varia/MaterialProfile.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Basic example for producing a profile of SLD of a multilayer. """ diff --git a/Examples/varia/MaterialProfileWithParticles.py b/Examples/varia/MaterialProfileWithParticles.py index ffa2224a273ce721308ec7fe852077d53c789506..02f7b25910ea4c8e7715113b84a8d0348ca66cb6 100644 --- a/Examples/varia/MaterialProfileWithParticles.py +++ b/Examples/varia/MaterialProfileWithParticles.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example for producing a profile of SLD of a multilayer with particles and slicing. diff --git a/Examples/varia/OffSpecularSimulation.py b/Examples/varia/OffSpecularSimulation.py index fb437dd34448629bb4e5505eca4c28832e1a64ed..023e03050a11be786df1ea19141f3d0e6c978931 100644 --- a/Examples/varia/OffSpecularSimulation.py +++ b/Examples/varia/OffSpecularSimulation.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Long boxes at 1D lattice, ba.OffSpecular simulation """ diff --git a/Examples/varia/PolarizedNoAnalyzer.py b/Examples/varia/PolarizedNoAnalyzer.py index a2d83342b89d86eb82e9130b5687b849ecb81bc9..6c1ec76a7839fbfecc689d2b166fcaa65047749f 100644 --- a/Examples/varia/PolarizedNoAnalyzer.py +++ b/Examples/varia/PolarizedNoAnalyzer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of computing splin-flip reflectivity from a magnetized sample. diff --git a/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py b/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py index afda3b0bf9b9843fb57ed2dfa7ced1ea1210334d..5c47342d9fd32d08ad8c9dbb85b388e8c41d4490 100644 --- a/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py +++ b/Examples/varia/PolarizedNonperfectAnalyzerPolarizer.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example that shows how to simulate a non-perfect polarizer and analyzer diff --git a/Examples/varia/PolarizedSANS.py b/Examples/varia/PolarizedSANS.py index 00595d49e693ff32a5b6378f5e81e7940c506b23..7c07918c1acfc59f5fe319c43ccb2cda701c965d 100644 --- a/Examples/varia/PolarizedSANS.py +++ b/Examples/varia/PolarizedSANS.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simple example demonstrating how polarized SANS experiments can be simulated with BornAgain. diff --git a/Examples/varia/PolarizedSpinAsymmetry.py b/Examples/varia/PolarizedSpinAsymmetry.py index c38a15665806cadd28215ce99d12d7f21e913f3a..b5e4d71c057e61e922c65a4a8fa8c663b84f97d5 100644 --- a/Examples/varia/PolarizedSpinAsymmetry.py +++ b/Examples/varia/PolarizedSpinAsymmetry.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ This simulation example demonstrates how to replicate the fitting example "Magnetically Dead Layers in Spinel Films" diff --git a/Examples/varia/PolarizedSpinFlip.py b/Examples/varia/PolarizedSpinFlip.py index d138358ed66accff52005ec0e8fff5c1ef98699b..c393b7bf5cd1e324d6964a6fabd2917c981af2be 100644 --- a/Examples/varia/PolarizedSpinFlip.py +++ b/Examples/varia/PolarizedSpinFlip.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ An example of computing splin-flip reflectivity from a magnetized sample. diff --git a/Examples/varia/RectangularDetector.py b/Examples/varia/RectangularDetector.py index 81cfa4d73d9f8a476f64d8f7768cfe3322f8304d..030b6be9071f1a3fa965e16e9b74d5f7bd9321ac 100644 --- a/Examples/varia/RectangularDetector.py +++ b/Examples/varia/RectangularDetector.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Simulation with rectangular detector. Pilatus3-1M detector is used as an example. Results will be compared against simulation with spherical detector. diff --git a/Examples/varia/ResonatorOffSpecSetup.py b/Examples/varia/ResonatorOffSpecSetup.py index fe5faa1480ee5649fb1de48fac0870f56dfa6f48..66ab0dea37c830c16abb66bcba995e6d1d577c6d 100644 --- a/Examples/varia/ResonatorOffSpecSetup.py +++ b/Examples/varia/ResonatorOffSpecSetup.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Resonator in off-specular experiment. """ diff --git a/Examples/varia/RoughnessModel.py b/Examples/varia/RoughnessModel.py index 041a31d29e51c4b47f80d5843f06657f3653fb36..3950e9750546ed84593c4761e9b49ee8234613ad 100644 --- a/Examples/varia/RoughnessModel.py +++ b/Examples/varia/RoughnessModel.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example of simulating a rough sample with a tanh and Nevot-Croce roughness model using BornAgain. diff --git a/Examples/varia/SimulationParameters.py b/Examples/varia/SimulationParameters.py index a4fd150cae884cfce70f49e54d6e2658fb489cc1..c3d2a400f04081f81cd5b135e7f6dd53658efe6a 100644 --- a/Examples/varia/SimulationParameters.py +++ b/Examples/varia/SimulationParameters.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Working with sample parameters. diff --git a/Examples/varia/SpecularSimulationWithRoughness.py b/Examples/varia/SpecularSimulationWithRoughness.py index 0fd4821842c010a46c3abab80df683c2ec53c7e9..72d9c59b6027abd1226dd2799b51ceb15f15d577 100644 --- a/Examples/varia/SpecularSimulationWithRoughness.py +++ b/Examples/varia/SpecularSimulationWithRoughness.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 """ Example of simulating a reflectometry experiment with a rough sample using BornAgain. diff --git a/auto/Wrap/doxygenBase.i b/auto/Wrap/doxygenBase.i index 5ae497b8532ff61737c997d7b89019086cf1273f..6b53a9f9f1306b8577f0401d63e529b59afbeee5 100644 --- a/auto/Wrap/doxygenBase.i +++ b/auto/Wrap/doxygenBase.i @@ -767,7 +767,7 @@ Returns value of last on-axis point. %feature("docstring") PointwiseAxis::binCenter "double PointwiseAxis::binCenter(size_t index) const override -Returns the coordinate corresponding to the given index. +Returns the coordinate corresponding to the given index. For this type of axis (\"pointwise\") this equals returning an explicitly defined coordinate. "; %feature("docstring") PointwiseAxis::findClosestIndex "size_t PointwiseAxis::findClosestIndex(double value) const override @@ -1436,6 +1436,9 @@ Returns string representing python stack trace. "; +// File: namespacestd.xml + + // File: namespaceStringUtils.xml %feature("docstring") StringUtils::matchesPattern "bool StringUtils::matchesPattern(const std::string &text, const std::string &wildcardPattern) diff --git a/auto/Wrap/doxygenFit.i b/auto/Wrap/doxygenFit.i index a57314eb406a69fa3f8ca1efeb4713ed2e96330b..0bc683d4cf0015560d3ad08a30696e6815da2f1f 100644 --- a/auto/Wrap/doxygenFit.i +++ b/auto/Wrap/doxygenFit.i @@ -3344,9 +3344,13 @@ Copy constructor for functor based on ROOT::Math::IMultiGenFunction "; %feature("docstring") ROOT::Math::Functor::Clone "ImplBase* ROOT::Math::Functor::Clone() const + +Clone a function. Each derived class must implement their version of the Clone method "; %feature("docstring") ROOT::Math::Functor::NDim "unsigned int ROOT::Math::Functor::NDim() const + +Retrieve the dimension of the function "; @@ -3596,6 +3600,71 @@ C++ includes: GenericFunction.h "; +// File: classGeneticMinimizer.xml +%feature("docstring") GeneticMinimizer " + +Wrapper for the CERN ROOT Genetic minimizer. + +C++ includes: GeneticMinimizer.h +"; + +%feature("docstring") GeneticMinimizer::GeneticMinimizer "GeneticMinimizer::GeneticMinimizer() +"; + +%feature("docstring") GeneticMinimizer::~GeneticMinimizer "GeneticMinimizer::~GeneticMinimizer() +"; + +%feature("docstring") GeneticMinimizer::setTolerance "void GeneticMinimizer::setTolerance(double value) + +Sets tolerance on the function value at the minimum. Minimization will stop when the estimated vertical distance to the minimum (EDM) is less than 0.001*tolerance*ErrorDef. Here ErrorDef=1.0 for chi squared fit and ErrorDef=0.5 for negative log likelihood fit. +"; + +%feature("docstring") GeneticMinimizer::tolerance "double GeneticMinimizer::tolerance() const +"; + +%feature("docstring") GeneticMinimizer::setPrintLevel "void GeneticMinimizer::setPrintLevel(int value) + +Sets minimizer internal print level. +"; + +%feature("docstring") GeneticMinimizer::printLevel "int GeneticMinimizer::printLevel() const +"; + +%feature("docstring") GeneticMinimizer::setMaxIterations "void GeneticMinimizer::setMaxIterations(int value) + +Sets maximum number of iterations to try at each step. +"; + +%feature("docstring") GeneticMinimizer::maxIterations "int GeneticMinimizer::maxIterations() const +"; + +%feature("docstring") GeneticMinimizer::setPopulationSize "void GeneticMinimizer::setPopulationSize(int value) + +Sets population size. +"; + +%feature("docstring") GeneticMinimizer::populationSize "int GeneticMinimizer::populationSize() const +"; + +%feature("docstring") GeneticMinimizer::setRandomSeed "void GeneticMinimizer::setRandomSeed(int value) + +Sets random seed. +"; + +%feature("docstring") GeneticMinimizer::randomSeed "int GeneticMinimizer::randomSeed() const +"; + +%feature("docstring") GeneticMinimizer::statusToString "std::string GeneticMinimizer::statusToString() const override + +Returns string representation of current minimizer status. +"; + +%feature("docstring") GeneticMinimizer::statusMap "std::map< std::string, std::string > GeneticMinimizer::statusMap() const override + +Returns map of string representing different minimizer statuses. +"; + + // File: classROOT_1_1Math_1_1GeneticMinimizer.xml %feature("docstring") ROOT::Math::GeneticMinimizer " @@ -3710,71 +3779,6 @@ retrieve the minimizer options (implement derived class if needed) "; -// File: classGeneticMinimizer.xml -%feature("docstring") GeneticMinimizer " - -Wrapper for the CERN ROOT Genetic minimizer. - -C++ includes: GeneticMinimizer.h -"; - -%feature("docstring") GeneticMinimizer::GeneticMinimizer "GeneticMinimizer::GeneticMinimizer() -"; - -%feature("docstring") GeneticMinimizer::~GeneticMinimizer "GeneticMinimizer::~GeneticMinimizer() -"; - -%feature("docstring") GeneticMinimizer::setTolerance "void GeneticMinimizer::setTolerance(double value) - -Sets tolerance on the function value at the minimum. Minimization will stop when the estimated vertical distance to the minimum (EDM) is less than 0.001*tolerance*ErrorDef. Here ErrorDef=1.0 for chi squared fit and ErrorDef=0.5 for negative log likelihood fit. -"; - -%feature("docstring") GeneticMinimizer::tolerance "double GeneticMinimizer::tolerance() const -"; - -%feature("docstring") GeneticMinimizer::setPrintLevel "void GeneticMinimizer::setPrintLevel(int value) - -Sets minimizer internal print level. -"; - -%feature("docstring") GeneticMinimizer::printLevel "int GeneticMinimizer::printLevel() const -"; - -%feature("docstring") GeneticMinimizer::setMaxIterations "void GeneticMinimizer::setMaxIterations(int value) - -Sets maximum number of iterations to try at each step. -"; - -%feature("docstring") GeneticMinimizer::maxIterations "int GeneticMinimizer::maxIterations() const -"; - -%feature("docstring") GeneticMinimizer::setPopulationSize "void GeneticMinimizer::setPopulationSize(int value) - -Sets population size. -"; - -%feature("docstring") GeneticMinimizer::populationSize "int GeneticMinimizer::populationSize() const -"; - -%feature("docstring") GeneticMinimizer::setRandomSeed "void GeneticMinimizer::setRandomSeed(int value) - -Sets random seed. -"; - -%feature("docstring") GeneticMinimizer::randomSeed "int GeneticMinimizer::randomSeed() const -"; - -%feature("docstring") GeneticMinimizer::statusToString "std::string GeneticMinimizer::statusToString() const override - -Returns string representation of current minimizer status. -"; - -%feature("docstring") GeneticMinimizer::statusMap "std::map< std::string, std::string > GeneticMinimizer::statusMap() const override - -Returns map of string representing different minimizer statuses. -"; - - // File: structROOT_1_1Math_1_1GeneticMinimizerParameters.xml %feature("docstring") ROOT::Math::GeneticMinimizerParameters ""; @@ -8003,8 +8007,8 @@ This table describes the properties of the MIXMAX generators. MIXMAX is a genuin $p=2^{61}-1$ is the Mersenne prime number. The MIXMAX generators with these parameters pass all of the BigCrush tests in the <a href=\"http://simul.iro.umontreal.ca/testu01/tu01.html\">TestU01 suite</a\\\\>. - -\\\\begin{table}[h] + + \\\\begin{table}[h] \\\\centering \\\\begin{tabular}{@{} rrlcrr @{}} @@ -8871,14 +8875,14 @@ ask for MinosError (Lower + Upper) can be printed via std::cout "; -// File: classROOT_1_1Minuit2_1_1MinimumError_1_1MnNotPosDef.xml -%feature("docstring") ROOT::Minuit2::MinimumError::MnNotPosDef ""; - - // File: classROOT_1_1Minuit2_1_1BasicMinimumError_1_1MnNotPosDef.xml %feature("docstring") ROOT::Minuit2::BasicMinimumError::MnNotPosDef ""; +// File: classROOT_1_1Minuit2_1_1MinimumError_1_1MnNotPosDef.xml +%feature("docstring") ROOT::Minuit2::MinimumError::MnNotPosDef ""; + + // File: classROOT_1_1Minuit2_1_1MnParabola.xml %feature("docstring") ROOT::Minuit2::MnParabola " @@ -12602,6 +12606,8 @@ Return the number of Parameters "; %feature("docstring") ROOT::Math::WrappedParamFunctionGen::NDim "unsigned int ROOT::Math::WrappedParamFunctionGen< FuncPtr >::NDim() const + +Retrieve the dimension of the function "; @@ -12703,6 +12709,9 @@ Returns horizontal line of 80 characters length with section name in it. "; +// File: namespaceParentFunctor.xml + + // File: namespaceROOT.xml @@ -13219,6 +13228,9 @@ LAPACK Algebra function specialize the Outer_product function for LAVector; "; +// File: namespacestd.xml + + // File: namespaceTestFunctions.xml %feature("docstring") TestFunctions::RosenBrock "double TestFunctions::RosenBrock(const std::vector< double > &par) @@ -13241,6 +13253,9 @@ Decaying sinus from lmfit tutorial. "; +// File: namespacetesting.xml + + // File: namespaceTMath.xml %feature("docstring") TMath::Abs "Short_t TMath::Abs(Short_t d) "; @@ -15056,10 +15071,10 @@ Decaying sinus from lmfit tutorial. // File: dir_ead683f11b26d141553bc0f1c348dc86.xml -// File: dir_892d84e8d1420bf45a9053cf0eede900.xml +// File: dir_05e24f99ab216f03e9d0cf366ad39939.xml -// File: dir_05e24f99ab216f03e9d0cf366ad39939.xml +// File: dir_892d84e8d1420bf45a9053cf0eede900.xml // File: dir_ddbc8017d498762c6500a9e593e25277.xml @@ -15071,10 +15086,10 @@ Decaying sinus from lmfit tutorial. // File: dir_346bee264126587e5b77542d134e4add.xml -// File: dir_5432497378cfbce702dc5799f292905b.xml +// File: dir_7c95011753c2f8fb6f2a9c22c1fbdc50.xml -// File: dir_7c95011753c2f8fb6f2a9c22c1fbdc50.xml +// File: dir_5432497378cfbce702dc5799f292905b.xml // File: dir_60772aca5f018fa4d428540699d2a67c.xml diff --git a/auto/Wrap/doxygenSample.i b/auto/Wrap/doxygenSample.i index a05b6b7c45791deccd18b5df2cc387bffdac3f08..6e218ea906f23c315fb91a55ca651d42ea1a209e 100644 --- a/auto/Wrap/doxygenSample.i +++ b/auto/Wrap/doxygenSample.i @@ -7867,7 +7867,7 @@ Complex form factor of rectangular ripple (bar). %feature("docstring") ripples::profile_yz_cosine "complex_t ripples::profile_yz_cosine(complex_t qy, complex_t qz, double width, double height) -Complex form factor of triangular ripple. +Complex form factor of cosine ripple. "; %feature("docstring") ripples::profile_yz_triangular "complex_t ripples::profile_yz_triangular(complex_t qy, complex_t qz, double width, double height, double asymmetry)