Source Code for Module paramz.domains

 1  #=============================================================================== 
 2  # Copyright (c) 2015, Max Zwiessele 
 3  # All rights reserved. 
 4  #  
 5  # Redistribution and use in source and binary forms, with or without 
 6  # modification, are permitted provided that the following conditions are met: 
 7  #  
 8  # * Redistributions of source code must retain the above copyright notice, this 
 9  #   list of conditions and the following disclaimer. 
10  #  
11  # * Redistributions in binary form must reproduce the above copyright notice, 
12  #   this list of conditions and the following disclaimer in the documentation 
13  #   and/or other materials provided with the distribution. 
14  #  
15  # * Neither the name of paramax nor the names of its 
16  #   contributors may be used to endorse or promote products derived from 
17  #   this software without specific prior written permission. 
18  #  
19  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
20  # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
21  # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
22  # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
23  # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
24  # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
25  # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
26  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
27  # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
28  # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
29  #=============================================================================== 
30   
31  """ 
32  (Hyper-)Parameter domains defined for :py:mod:`paramz.transformations`. 
33  These domains specify the legitimate realm of the parameters to live in. 
34   
35  :const:`~paramz.domains._REAL` : 
36      real domain, all values in the real numbers are allowed 
37   
38  :const:`~paramz.domains._POSITIVE`: 
39      positive domain, only positive real values are allowed 
40   
41  :const:`~paramz.domains._NEGATIVE`: 
42      same as :const:`~paramz.domains._POSITIVE`, but only negative values are allowed 
43   
44  :const:`~paramz.domains._BOUNDED`: 
45      only values within the bounded range are allowed, 
46      the bounds are specified withing the object with the bounded range 
47  """ 
48   
49  _REAL = 'real' 
50  _POSITIVE = "positive" 
51  _NEGATIVE = 'negative' 
52  _BOUNDED = 'bounded' 
53