/// <summary>
/// Determines if a reporting period is greater than and adjacent to a second reporting period.
/// </summary>
/// <remarks>
/// For this method to return true, the first reporting period's Start must be greater than the
/// second reporting period's End, and they must be adjacent (subtracting one unit in the same granularity
/// to the first reporting period's Start should make it equal to the second reporting period's End)
/// For example, 3Q2017-4Q2017 is greater than and adjacent to 1Q2017-2Q2017.
/// For example, 3Q2017-4Q2017 is NOT greater than 1Q2017-3Q2017, because they overlap.
/// For example, 4Q2017-4Q2017 is NOT adjacent to 1Q2017-2Q2017, because there's a gap of 3Q2017.
/// </remarks>
/// <param name="reportingPeriod1">A reporting period to check if greater than and adjacent to a second reporting period.</param>
/// <param name="reportingPeriod2">The second reporting period.</param>
/// <returns>
/// true if the first reporting period is greater than and adjacent to the second reporting period; false, otherwise.
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod1"/> is null.</exception>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod2"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="reportingPeriod1"/> cannot be compared against <paramref name="reportingPeriod2"/> because they represent different <see cref="UnitOfTime.UnitOfTimeKind"/>.</exception>
public static bool IsGreaterThanAndAdjacentTo(
this ReportingPeriod reportingPeriod1,
ReportingPeriod reportingPeriod2)
{
if (reportingPeriod1 == null)
{
throw new ArgumentNullException(nameof(reportingPeriod1));
}
if (reportingPeriod2 == null)
{
throw new ArgumentNullException(nameof(reportingPeriod2));
}
if (reportingPeriod1.GetUnitOfTimeKind() != reportingPeriod2.GetUnitOfTimeKind())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod1)} cannot be compared against {nameof(reportingPeriod2)} because they represent different {nameof(UnitOfTimeKind)}."));
}
var mostGranularReportingPeriod1 = reportingPeriod1.ToMostGranular();
var mostGranularReportingPeriod2 = reportingPeriod2.ToMostGranular();
var result = mostGranularReportingPeriod1.Start.Plus(-1).Equals(mostGranularReportingPeriod2.End);
return(result);
}
/// <summary>
/// Determines if two reporting periods overlap.
/// For example, the following reporting periods have an overlap: 1Q2017-3Q2017 and 3Q2017-4Q2017.
/// </summary>
/// <remarks>
/// If the endpoint of one reporting period is the same as the endpoint
/// of the second reporting period, the reporting periods are deemed to overlap.
/// </remarks>
/// <param name="reportingPeriod1">A reporting period.</param>
/// <param name="reportingPeriod2">A second reporting period to check for overlap against the first reporting period.</param>
/// <returns>
/// true if there is an overlap between the reporting periods; false otherwise.
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod1"/> is null.</exception>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod2"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="reportingPeriod1"/> cannot be compared against <paramref name="reportingPeriod2"/> because they represent different <see cref="UnitOfTime.UnitOfTimeKind"/>.</exception>
public static bool HasOverlapWith(
this ReportingPeriod reportingPeriod1,
ReportingPeriod reportingPeriod2)
{
if (reportingPeriod1 == null)
{
throw new ArgumentNullException(nameof(reportingPeriod1));
}
if (reportingPeriod2 == null)
{
throw new ArgumentNullException(nameof(reportingPeriod2));
}
if (reportingPeriod1.GetUnitOfTimeKind() != reportingPeriod2.GetUnitOfTimeKind())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod1)} cannot be compared against {nameof(reportingPeriod2)} because they represent different {nameof(UnitOfTimeKind)}"));
}
var result =
reportingPeriod1.Contains(reportingPeriod2.Start) ||
reportingPeriod1.Contains(reportingPeriod2.End) ||
reportingPeriod2.Contains(reportingPeriod1.Start) ||
reportingPeriod2.Contains(reportingPeriod1.End);
return(result);
}
/// <summary>
/// Determines if a unit-of-time is contained within a reporting period.
/// For example, 2Q2017 is contained within a reporting period of 1Q2017-4Q2017.
/// </summary>
/// <remarks>
/// If the unit-of-time is equal to one of the endpoints of the reporting period,
/// that unit-of-time is considered to be within the reporting period.
/// </remarks>
/// <param name="reportingPeriod">The reporting period.</param>
/// <param name="unitOfTime">The unit-of-time to check against a reporting period.</param>
/// <returns>
/// true if the unit-of-time is contained within the reporting period; false otherwise.
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="unitOfTime"/> is null.</exception>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="unitOfTime"/> cannot be compared against <paramref name="reportingPeriod"/> because they represent different <see cref="UnitOfTime.UnitOfTimeKind"/>.</exception>
public static bool Contains(
this ReportingPeriod reportingPeriod,
UnitOfTime unitOfTime)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (unitOfTime == null)
{
throw new ArgumentNullException(nameof(unitOfTime));
}
if (unitOfTime.UnitOfTimeKind != reportingPeriod.GetUnitOfTimeKind())
{
throw new ArgumentException(Invariant($"{nameof(unitOfTime)} cannot be compared against {nameof(reportingPeriod)} because they represent different {nameof(UnitOfTimeKind)}."));
}
var result = reportingPeriod.Contains(new ReportingPeriod(unitOfTime, unitOfTime));
return(result);
}
/// <summary>
/// Determines if a reporting period is contained within another reporting period.
/// For example, 1Q2017-3Q2017 contains 2Q2017-3Q2017.
/// </summary>
/// <remarks>
/// If an endpoint in the second reporting period equals an endpoint in the first reporting period, that endpoint
/// is considered to be contained within the first reporting period. Of course, both endpoints must be contained
/// within the reporting period for this method to return true.
/// </remarks>
/// <param name="reportingPeriod1">A reporting period.</param>
/// <param name="reportingPeriod2">A second reporting period to check for containment within the first reporting period.</param>
/// <returns>
/// true if the first reporting period contains the second one; false if not.
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod1"/> is null.</exception>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod2"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="reportingPeriod1"/> cannot be compared against <paramref name="reportingPeriod2"/> because they represent different <see cref="UnitOfTime.UnitOfTimeKind"/>.</exception>
public static bool Contains(
this ReportingPeriod reportingPeriod1,
ReportingPeriod reportingPeriod2)
{
if (reportingPeriod1 == null)
{
throw new ArgumentNullException(nameof(reportingPeriod1));
}
if (reportingPeriod2 == null)
{
throw new ArgumentNullException(nameof(reportingPeriod2));
}
if (reportingPeriod1.GetUnitOfTimeKind() != reportingPeriod2.GetUnitOfTimeKind())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod1)} cannot be compared against {nameof(reportingPeriod2)} because they represent different {nameof(UnitOfTimeKind)}."));
}
reportingPeriod1 = reportingPeriod1.ToMostGranular();
reportingPeriod2 = reportingPeriod2.ToMostGranular();
bool startIsContained;
if (reportingPeriod1.Start.UnitOfTimeGranularity == UnitOfTimeGranularity.Unbounded)
{
startIsContained = true;
}
else
{
if (reportingPeriod2.Start.UnitOfTimeGranularity == UnitOfTimeGranularity.Unbounded)
{
startIsContained = false;
}
else
{
startIsContained = reportingPeriod1.Start.CompareTo(reportingPeriod2.Start) <= 0;
}
}
bool endIsContained;
if (reportingPeriod1.End.UnitOfTimeGranularity == UnitOfTimeGranularity.Unbounded)
{
endIsContained = true;
}
else
{
if (reportingPeriod2.End.UnitOfTimeGranularity == UnitOfTimeGranularity.Unbounded)
{
endIsContained = false;
}
else
{
endIsContained = reportingPeriod1.End.CompareTo(reportingPeriod2.End) >= 0;
}
}
var result = startIsContained && endIsContained;
return(result);
}
/// <summary>
/// Gets the matching datapoints from a timeseries.
/// </summary>
/// <typeparam name="T">The type of value of the datapoints.</typeparam>
/// <param name="timeseries">The timeseries.</param>
/// <param name="reportingPeriod">The reporting period to search for.</param>
/// <param name="reportingPeriodComparison">OPTIONAL value that determines how the reporting period of the datapoints in <paramref name="timeseries"/> are compared to <paramref name="reportingPeriod"/>. DEFAULT is to match when the reporting periods are equal, ignoring granularity.</param>
/// <returns>
/// The matching datapoints or an empty collection if there are none.
/// If using <see cref="ReportingPeriodComparison.IsEqualToIgnoringGranularity"/> or <see cref="ReportingPeriodComparison.Contains"/>
/// then a single datapoint will be returned at most.
/// </returns>
/// <exception cref="ArgumentNullException"><paramref name="timeseries"/> is null.</exception>
/// <exception cref="ArgumentNullException"><paramref name="reportingPeriod"/> is null.</exception>
/// <exception cref="NotSupportedException"><paramref name="reportingPeriodComparison"/> is not supported.</exception>
public static IReadOnlyList <Datapoint <T> > GetMatchingDatapoints <T>(
this Timeseries <T> timeseries,
ReportingPeriod reportingPeriod,
ReportingPeriodComparison reportingPeriodComparison = ReportingPeriodComparison.IsEqualToIgnoringGranularity)
{
if (timeseries == null)
{
throw new ArgumentNullException(nameof(timeseries));
}
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
IReadOnlyList <Datapoint <T> > result;
if (reportingPeriodComparison == ReportingPeriodComparison.IsEqualToIgnoringGranularity)
{
var mostGranularReportingPeriod = reportingPeriod.ToMostGranular();
result = timeseries.Datapoints.Where(_ => _.ReportingPeriod.ToMostGranular().Equals(mostGranularReportingPeriod)).ToList();
}
else if (reportingPeriodComparison == ReportingPeriodComparison.Contains)
{
result = timeseries.Datapoints.Where(_ => (_.ReportingPeriod.GetUnitOfTimeKind() == reportingPeriod.GetUnitOfTimeKind()) && _.ReportingPeriod.Contains(reportingPeriod)).ToList();
}
else
{
throw new NotSupportedException(Invariant($"This {nameof(ReportingPeriodComparison)} is not supported: {reportingPeriodComparison}."));
}
return(result);
}
private static ReportingPeriod MakeLessGranular(
this ReportingPeriod reportingPeriod,
UnitOfTimeGranularity granularity,
bool throwOnMisalignment = true)
{
if (reportingPeriod == null)
{
throw new ArgumentNullException(nameof(reportingPeriod));
}
if (reportingPeriod.HasComponentWithUnboundedGranularity())
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} has an {nameof(UnitOfTimeGranularity.Unbounded)} component."));
}
if (granularity == UnitOfTimeGranularity.Invalid)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Invalid}'"), (Exception)null);
}
if (granularity == UnitOfTimeGranularity.Unbounded)
{
throw new ArgumentOutOfRangeException(Invariant($"'{nameof(granularity)}' == '{UnitOfTimeGranularity.Unbounded}'"), (Exception)null);
}
var reportingPeriodGranularity = reportingPeriod.GetUnitOfTimeGranularity();
if (reportingPeriodGranularity.IsAsGranularOrLessGranularThan(granularity))
{
throw new ArgumentException(Invariant($"{nameof(reportingPeriod)} is as granular or less granular than {nameof(granularity)}."));
}
ReportingPeriod lessGranularReportingPeriod;
var unitOfTimeKind = reportingPeriod.GetUnitOfTimeKind();
if (reportingPeriodGranularity == UnitOfTimeGranularity.Day)
{
if (unitOfTimeKind == UnitOfTimeKind.Calendar)
{
var startAsCalendarDay = reportingPeriod.Start as CalendarDay;
// ReSharper disable once PossibleNullReferenceException
var startMonth = new CalendarMonth(startAsCalendarDay.Year, startAsCalendarDay.MonthOfYear);
if ((startMonth.GetFirstCalendarDay() != startAsCalendarDay) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a calendar day reporting period to a calendar month reporting period when the reporting period start time is not the first day of a month.");
}
var endAsCalendarDay = reportingPeriod.End as CalendarDay;
// ReSharper disable once PossibleNullReferenceException
var endMonth = new CalendarMonth(endAsCalendarDay.Year, endAsCalendarDay.MonthOfYear);
if ((endMonth.GetLastCalendarDay() != endAsCalendarDay) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a calendar day reporting period to a calendar month reporting period when the reporting period end time is not the last day of a month.");
}
lessGranularReportingPeriod = new ReportingPeriod(startMonth, endMonth);
}
else
{
throw new NotSupportedException("This kind of unit-of-time is not supported: " + unitOfTimeKind);
}
}
else if (reportingPeriodGranularity == UnitOfTimeGranularity.Month)
{
var startAsMonth = reportingPeriod.Start as IHaveAMonth;
var endAsMonth = reportingPeriod.End as IHaveAMonth;
var validStartMonths = new HashSet <int> {
1, 4, 7, 10
};
// ReSharper disable once PossibleNullReferenceException
if ((!validStartMonths.Contains((int)startAsMonth.MonthNumber)) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a monthly reporting period to a quarterly reporting period when the reporting period start time is not the first month of a recognized quarter.");
}
var validEndMonths = new HashSet <int> {
3, 6, 9, 12
};
// ReSharper disable once PossibleNullReferenceException
if ((!validEndMonths.Contains((int)endAsMonth.MonthNumber)) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a monthly reporting period to a quarterly reporting period when the reporting period end time is not the last month of a recognized quarter.");
}
var monthNumberToQuarterMap = new Dictionary <int, QuarterNumber>
{
{ 1, QuarterNumber.Q1 },
{ 2, QuarterNumber.Q1 },
{ 3, QuarterNumber.Q1 },
{ 4, QuarterNumber.Q2 },
{ 5, QuarterNumber.Q2 },
{ 6, QuarterNumber.Q2 },
{ 7, QuarterNumber.Q3 },
{ 8, QuarterNumber.Q3 },
{ 9, QuarterNumber.Q3 },
{ 10, QuarterNumber.Q4 },
{ 11, QuarterNumber.Q4 },
{ 12, QuarterNumber.Q4 },
};
if (unitOfTimeKind == UnitOfTimeKind.Calendar)
{
var startQuarter = new CalendarQuarter(startAsMonth.Year, monthNumberToQuarterMap[(int)startAsMonth.MonthNumber]);
var endQuarter = new CalendarQuarter(endAsMonth.Year, monthNumberToQuarterMap[(int)endAsMonth.MonthNumber]);
lessGranularReportingPeriod = new ReportingPeriod(startQuarter, endQuarter);
}
else if (unitOfTimeKind == UnitOfTimeKind.Fiscal)
{
var startQuarter = new FiscalQuarter(startAsMonth.Year, monthNumberToQuarterMap[(int)startAsMonth.MonthNumber]);
var endQuarter = new FiscalQuarter(endAsMonth.Year, monthNumberToQuarterMap[(int)endAsMonth.MonthNumber]);
lessGranularReportingPeriod = new ReportingPeriod(startQuarter, endQuarter);
}
else if (unitOfTimeKind == UnitOfTimeKind.Generic)
{
var startQuarter = new GenericQuarter(startAsMonth.Year, monthNumberToQuarterMap[(int)startAsMonth.MonthNumber]);
var endQuarter = new GenericQuarter(endAsMonth.Year, monthNumberToQuarterMap[(int)endAsMonth.MonthNumber]);
lessGranularReportingPeriod = new ReportingPeriod(startQuarter, endQuarter);
}
else
{
throw new NotSupportedException("This kind of unit-of-time is not supported: " + unitOfTimeKind);
}
}
else if (reportingPeriodGranularity == UnitOfTimeGranularity.Quarter)
{
var startAsQuarter = reportingPeriod.Start as IHaveAQuarter;
var endAsQuarter = reportingPeriod.End as IHaveAQuarter;
// ReSharper disable once PossibleNullReferenceException
if ((startAsQuarter.QuarterNumber != QuarterNumber.Q1) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a quarterly reporting period to a yearly reporting period when the reporting period start time is not Q1.");
}
// ReSharper disable once PossibleNullReferenceException
if ((endAsQuarter.QuarterNumber != QuarterNumber.Q4) && throwOnMisalignment)
{
throw new InvalidOperationException("Cannot convert a quarterly reporting period to a yearly reporting period when the reporting period end is not Q4.");
}
if (unitOfTimeKind == UnitOfTimeKind.Calendar)
{
var startYear = new CalendarYear(startAsQuarter.Year);
var endYear = new CalendarYear(endAsQuarter.Year);
lessGranularReportingPeriod = new ReportingPeriod(startYear, endYear);
}
else if (unitOfTimeKind == UnitOfTimeKind.Fiscal)
{
var startYear = new FiscalYear(startAsQuarter.Year);
var endYear = new FiscalYear(endAsQuarter.Year);
lessGranularReportingPeriod = new ReportingPeriod(startYear, endYear);
}
else if (unitOfTimeKind == UnitOfTimeKind.Generic)
{
var startYear = new GenericYear(startAsQuarter.Year);
var endYear = new GenericYear(endAsQuarter.Year);
lessGranularReportingPeriod = new ReportingPeriod(startYear, endYear);
}
else
{
throw new NotSupportedException("This kind of unit-of-time is not supported: " + unitOfTimeKind);
}
}
else
{
throw new NotSupportedException("This granularity is not supported: " + reportingPeriodGranularity);
}
if (lessGranularReportingPeriod.GetUnitOfTimeGranularity() == granularity)
{
return(lessGranularReportingPeriod);
}
var result = MakeLessGranular(lessGranularReportingPeriod, granularity, throwOnMisalignment);
return(result);
}