Class Factor
- Namespace
- Balsam.FactorAnalysis
- Assembly
- Balsam.Backtester.dll
Wraps an ISeries for factor analysis.
public class Factor
- Inheritance
-
Factor
- Inherited Members
- Extension Methods
Constructors
Factor(ISeries)
Instantiates a new factor using the specified series.
public Factor(ISeries series)
Parameters
series
ISeries
Factor(Func<BarSeries, ISeries>)
Instantiates a new factor for deferred evaluation.
public Factor(Func<BarSeries, ISeries> func)
Parameters
Properties
IsUniDirectional
Gets/sets whether the factor is interpreted the same for longs/shorts.
public bool IsUniDirectional { get; set; }
Property Value
Name
Gets/sets the factor name to use for display purposes.
public string Name { get; set; }
Property Value
Methods
Calculate(BarSeries)
Returns a new factor based on the specified BarSeries.
public Factor Calculate(BarSeries series)
Parameters
series
BarSeries
Returns
Calculate(IEnumerable<BarSeries>)
Returns a new factor based on the specified enumerable of BarSeries.
public Factor Calculate(IEnumerable<BarSeries> series)
Parameters
series
IEnumerable<BarSeries>
Returns
GetValue(DateTime)
Returns the value for the specified date.
public double GetValue(DateTime date)
Parameters
date
DateTime
Returns
GetValue(DateTime, string)
Returns the value for the specified date and symbol
public double GetValue(DateTime date, string symbol)
Parameters
Returns
ToString()
Returns a string representation of this object.
public override string ToString()
Returns
ToTimeSeries()
Converts this factor to a TimeSeries.
public TimeSeries ToTimeSeries()
Returns
Exceptions
ToTimeSeriesCollection()
Coverts this factor to a TimeSeriesCollection.
public TimeSeriesCollection ToTimeSeriesCollection()
Returns
Exceptions
Operators
implicit operator Factor(IntegerSeries)
Implicitly converts the specified IntegerSeries to a factor.
public static implicit operator Factor(IntegerSeries series)
Parameters
series
IntegerSeries
Returns
implicit operator Factor(TimeSeries)
Implictly converts the specified TimeSeries to a factor.
public static implicit operator Factor(TimeSeries series)
Parameters
series
TimeSeries
Returns
implicit operator Factor(TimeSeriesCollection)
Implictly converts the specified TimeSeriesCollection to a factor.
public static implicit operator Factor(TimeSeriesCollection series)
Parameters
series
TimeSeriesCollection