File size: 3,639 Bytes
62da328 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
from typing import List
from camel.toolkits.base import BaseToolkit
from camel.toolkits.function_tool import FunctionTool
class MathToolkit(BaseToolkit):
r"""A class representing a toolkit for mathematical operations.
This class provides methods for basic mathematical operations such as
addition, subtraction, multiplication, division, and rounding.
"""
def add(self, a: float, b: float) -> float:
r"""Adds two numbers.
Args:
a (float): The first number to be added.
b (float): The second number to be added.
Returns:
float: The sum of the two numbers.
"""
return a + b
def sub(self, a: float, b: float) -> float:
r"""Do subtraction between two numbers.
Args:
a (float): The minuend in subtraction.
b (float): The subtrahend in subtraction.
Returns:
float: The result of subtracting :obj:`b` from :obj:`a`.
"""
return a - b
def multiply(self, a: float, b: float, decimal_places: int = 2) -> float:
r"""Multiplies two numbers.
Args:
a (float): The multiplier in the multiplication.
b (float): The multiplicand in the multiplication.
decimal_places (int, optional): The number of decimal
places to round to. Defaults to 2.
Returns:
float: The product of the two numbers.
"""
return round(a * b, decimal_places)
def divide(self, a: float, b: float, decimal_places: int = 2) -> float:
r"""Divides two numbers.
Args:
a (float): The dividend in the division.
b (float): The divisor in the division.
decimal_places (int, optional): The number of
decimal places to round to. Defaults to 2.
Returns:
float: The result of dividing :obj:`a` by :obj:`b`.
"""
return round(a / b, decimal_places)
def round(self, a: float, decimal_places: int = 0) -> float:
r"""Rounds a number to a specified number of decimal places.
Args:
a (float): The number to be rounded.
decimal_places (int, optional): The number of decimal places
to round to. Defaults to 0.
Returns:
float: The rounded number.
"""
return round(a, decimal_places)
def get_tools(self) -> List[FunctionTool]:
r"""Returns a list of FunctionTool objects representing the
functions in the toolkit.
Returns:
List[FunctionTool]: A list of FunctionTool objects
representing the functions in the toolkit.
"""
return [
FunctionTool(self.add),
FunctionTool(self.sub),
FunctionTool(self.multiply),
FunctionTool(self.divide),
FunctionTool(self.round),
]
|