Fraction.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for Fraction class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) is free software: you can redistribute it
* and/or modify it under the terms of the GNU Lesser 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 (libopenshot) 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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
openshot::Fraction::num
int num
Numerator for the fraction.
Definition: Fraction.h:44
openshot::Fraction::ToFloat
float ToFloat()
Return this fraction as a float (i.e. 1/2 = 0.5)
Definition: Fraction.cpp:41
openshot::Fraction::Reduce
void Reduce()
Reduce this fraction (i.e. 640/480 = 4/3)
Definition: Fraction.cpp:71
openshot::Fraction::Reciprocal
Fraction Reciprocal()
Return the reciprocal as a Fraction.
Definition: Fraction.cpp:81
openshot::Fraction::GreatestCommonDenominator
int GreatestCommonDenominator()
Calculate the greatest common denominator.
Definition: Fraction.cpp:56
openshot::Fraction
This class represents a fraction.
Definition: Fraction.h:42
openshot::Fraction::ToInt
int ToInt()
Return a rounded integer of the fraction (for example 30000/1001 returns 30)
Definition: Fraction.cpp:51
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:45
openshot::Fraction::Fraction
Fraction()
Default Constructor.
Definition: Fraction.cpp:33
openshot::Fraction::den
int den
Denominator for the fraction.
Definition: Fraction.h:45
openshot::Fraction::ToDouble
double ToDouble()
Return this fraction as a double (i.e. 1/2 = 0.5)
Definition: Fraction.cpp:46