Files
libopenshot/include/Fraction.h

75 lines
2.1 KiB
C++

/**
* @file
* @brief Header file for Fraction class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2013 OpenShot Studios, LLC
* (http://www.openshotstudios.com). This file is part of
* OpenShot Library (http://www.openshot.org), an open-source project
* dedicated to delivering high quality video editing and animation solutions
* to the world.
*
* OpenShot Library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* OpenShot Library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_FRACTION_H
#define OPENSHOT_FRACTION_H
#include <math.h>
namespace openshot {
/**
* @brief This class represents a fraction
*
* Fractions are often used in video editing to represent ratios and rates, for example:
* pixel ratios, frames per second, timebase, and other common ratios. Fractions are preferred
* over decimals due to their increased precision.
*/
class Fraction {
public:
int num; ///<Numerator for the fraction
int den; ///<Denominator for the fraction
/// Default Constructor
Fraction();
/// Constructor with numerator and denominator
Fraction(int num, int den);
/// Calculate the greatest common denominator
int GreatestCommonDenominator();
/// Reduce this fraction (i.e. 640/480 = 4/3)
void Reduce();
/// Return this fraction as a float (i.e. 1/2 = 0.5)
float ToFloat();
/// Return this fraction as a double (i.e. 1/2 = 0.5)
double ToDouble();
/// Return a rounded integer of the fraction (for example 30000/1001 returns 30)
int ToInt();
/// Return the reciprocal as a Fraction
Fraction Reciprocal();
};
}
#endif