Reference Guide
2.5.0
tangent_linear_error.py
1
# -----------------------------------------------------------------------------
2
# BSD 3-Clause License
3
#
4
# Copyright (c) 2021-2024, Science and Technology Facilities Council.
5
# All rights reserved.
6
#
7
# Redistribution and use in source and binary forms, with or without
8
# modification, are permitted provided that the following conditions are met:
9
#
10
# * Redistributions of source code must retain the above copyright notice, this
11
# list of conditions and the following disclaimer.
12
#
13
# * Redistributions in binary form must reproduce the above copyright notice,
14
# this list of conditions and the following disclaimer in the documentation
15
# and/or other materials provided with the distribution.
16
#
17
# * Neither the name of the copyright holder nor the names of its
18
# contributors may be used to endorse or promote products derived from
19
# this software without specific prior written permission.
20
#
21
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32
# POSSIBILITY OF SUCH DAMAGE.
33
# -----------------------------------------------------------------------------
34
# Author R. W. Ford and A. R. Porter, STFC Daresbury Lab
35
36
'''This module provides the TangentLinearError class.
37
'''
38
39
from
psyclone.errors
import
PSycloneError
40
41
# Disable Python3-specific way of calling parent as support is still
42
# required for Python2.
43
# pylint: disable=super-with-arguments
44
45
46
class
TangentLinearError
(
PSycloneError
):
47
'''Provides a PSyclone-specific error class for code that does not
48
conform to the constraints required to be valid tangent linear
49
code.
50
51
:param str value: the message associated with the error.
52
53
'''
54
def
__init__(self, value):
55
56
super(TangentLinearError, self).__init__(value)
57
self.
value
value
value =
"TangentLinearError: "
+str(value)
58
59
def
__str__(self):
60
return
self.
value
value
value
psyclone.errors.PSycloneError
Definition:
errors.py:73
psyclone.errors.PSycloneError.value
value
Definition:
errors.py:82
psyclone.psyad.transformations.tangent_linear_error.TangentLinearError
Definition:
tangent_linear_error.py:46
psyclone.psyad.transformations.tangent_linear_error.TangentLinearError.value
value
Definition:
tangent_linear_error.py:57
psyclone.errors
Definition:
errors.py:1
src
psyclone
psyad
transformations
tangent_linear_error.py
Generated by
1.9.1