Class BooleanSeries
- Namespace
- Balsam
- Assembly
- Balsam.Backtester.dll
A series of dates and associated true/false values.
[ProtoContract(IgnoreListHandling = true)]
public class BooleanSeries : SeriesBase<bool>, ISeries, IEnumerable<bool>, IEnumerable, ICloneable
- Inheritance
-
BooleanSeries
- Implements
- Inherited Members
- Extension Methods
Constructors
BooleanSeries()
Initializes a new emtpy BooleanSeries.
public BooleanSeries()
BooleanSeries(IEnumerable<DateTime>)
Initializes a new BooleanSeries using the specified dates.
public BooleanSeries(IEnumerable<DateTime> dates)
Parameters
dates
IEnumerable<DateTime>
BooleanSeries(IEnumerable<DateTime>, bool)
Initializes a new BooleanSeries using the specified parameters.
public BooleanSeries(IEnumerable<DateTime> dates, bool value)
Parameters
dates
IEnumerable<DateTime>value
bool
BooleanSeries(IEnumerable<DateTime>, IEnumerable<bool>)
Initializes a new BooleanSeries using the specified parameters.
public BooleanSeries(IEnumerable<DateTime> dates, IEnumerable<bool> values)
Parameters
dates
IEnumerable<DateTime>values
IEnumerable<bool>
Methods
Clone()
Returns a copy of this series.
public BooleanSeries Clone()
Returns
Equals(BooleanSeries)
Returns true when the specified series is identical to this one (all dates and values match).
public bool Equals(BooleanSeries series)
Parameters
series
BooleanSeries
Returns
Equals(BooleanSeries, BooleanSeries)
Returns true if all dates and values for the specified series are equal.
public static bool Equals(BooleanSeries left, BooleanSeries right)
Parameters
left
BooleanSeriesright
BooleanSeries
Returns
Load(string)
Loads a boolean series from the specified comma delimited file.
public static BooleanSeries Load(string fileName)
Parameters
fileName
string
Returns
Load(string, char)
Loads a boolean series from the specified file.
public static BooleanSeries Load(string fileName, char delimiter)
Parameters
Returns
Subset(DateTime)
Returns a new BooleanSeries starting at the specified start date.
public BooleanSeries Subset(DateTime startDate)
Parameters
startDate
DateTime
Returns
Subset(DateTime, DateTime)
Returns a new BooleanSeries containing dates between the specified start and end dates inclusive.
public BooleanSeries Subset(DateTime startDate, DateTime endDate)
Parameters
Returns
Subset(int, int)
Returns a subset of this BooleanSeries starting at the specified index.
public BooleanSeries Subset(int index, int count)
Parameters
index
intThe starting index.
count
intThe number of observations to return. Automatically adjusted to prevent out-of-bounds errors.
Returns
Sync(ISeries)
Returns a new BooleanSeries with dates synced to the specified series.
public BooleanSeries Sync(ISeries series)
Parameters
series
ISeries
Returns
Sync(ISeries, SyncOption)
Returns a new BooleanSeries synced to the specified series using the specified sync option.
public BooleanSeries Sync(ISeries series, SyncOption option)
Parameters
series
ISeriesoption
SyncOption
Returns
Sync(IEnumerable<DateTime>)
Returns a new BooleanSeries synced to the specified dates.
public BooleanSeries Sync(IEnumerable<DateTime> syncDates)
Parameters
syncDates
IEnumerable<DateTime>
Returns
Sync(IEnumerable<DateTime>, SyncOption)
Returns a new BooleanSeries synced to the specified dates.
public BooleanSeries Sync(IEnumerable<DateTime> syncDates, SyncOption option)
Parameters
syncDates
IEnumerable<DateTime>option
SyncOption
Returns
Operators
operator &(BooleanSeries, BooleanSeries)
Returns a new BooleanSeries where individual observations are true when both the left and right series are true.
public static BooleanSeries operator &(BooleanSeries left, BooleanSeries right)
Parameters
left
BooleanSeriesright
BooleanSeries
Returns
operator |(BooleanSeries, BooleanSeries)
Returns a new BooleanSeries where individual observations are true if either the left or right observation are true.
public static BooleanSeries operator |(BooleanSeries left, BooleanSeries right)
Parameters
left
BooleanSeriesright
BooleanSeries
Returns
explicit operator BooleanSeries(IntegerSeries)
Converts and integer series to a boolean series. Values of 1 evaluate to true; all other values are false.
public static explicit operator BooleanSeries(IntegerSeries series)
Parameters
series
IntegerSeries
Returns
explicit operator BooleanSeries(TimeSeries)
Converts a TimeSeries to BooleanSeries. Values of 1 equal true, all others false.
public static explicit operator BooleanSeries(TimeSeries series)
Parameters
series
TimeSeries
Returns
operator !(BooleanSeries)
Negates the values of the specified series.
public static BooleanSeries operator !(BooleanSeries series)
Parameters
series
BooleanSeries