Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Meta data output utility #1318

Draft
wants to merge 1 commit into
base: v3
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 0 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
// file settings
"files.autoSave": "off",
"files.autoSaveDelay": 3000,
"files.encoding": "utf8",
"files.exclude": {
"**/.vs/**": true,
Expand Down
8 changes: 4 additions & 4 deletions src/GlobalSuppressions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@
"CA1720:Identifier contains type name",
Justification = "Not really an issue.",
Scope = "member",
Target = "~F:Skender.Stock.Indicators.ChandelierType.Long")]
Target = "~F:ChandelierType.Long")]

[assembly: SuppressMessage("Naming",
"CA1720:Identifier contains type name"
, Justification = "Not really an issue.",
Scope = "type",
Target = "~T:Skender.Stock.Indicators.ChandelierType")]
Target = "~T:ChandelierType")]

[assembly: SuppressMessage(
"Naming",
"CA1720:Identifier contains type name",
Justification = "Not really an issue.",
Scope = "member",
Target = "~F:Skender.Stock.Indicators.ChandelierType.Short")]
Target = "~F:ChandelierType.Short")]

[assembly: SuppressMessage(
"Maintainability",
Expand All @@ -35,4 +35,4 @@
"CA1716:Identifiers should not match keywords",
Justification = "Temporary, during deprecation period.",
Scope = "member",
Target = "~P:Skender.Stock.Indicators.ISeries.Date")]
Target = "~P:ISeries.Date")]
11 changes: 6 additions & 5 deletions src/Indicators.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@

<PropertyGroup>
<TargetFrameworks>net9.0;net8.0;net6.0</TargetFrameworks>
<OutputType>Library</OutputType>
<LangVersion>13.0</LangVersion>

<AssemblyName>Skender.Stock.Indicators</AssemblyName>
<RootNamespace>Skender.Stock.Indicators</RootNamespace>
<NeutralLanguage>en-US</NeutralLanguage>

<Authors>Dave Skender</Authors>
<Product>Stock Indicators for .NET</Product>
<Copyright>@2020 Dave Skender</Copyright>
Expand All @@ -13,10 +18,6 @@
<RepositoryType>git</RepositoryType>
<PublishRepositoryUrl>true</PublishRepositoryUrl>

<AssemblyName>Skender.Stock.Indicators</AssemblyName>
<RootNamespace>Skender.Stock.Indicators</RootNamespace>
<NeutralLanguage>en-US</NeutralLanguage>

<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
<PackageProjectUrl>https://dotnet.stockindicators.dev</PackageProjectUrl>
Expand All @@ -43,7 +44,7 @@
<RunAnalyzersDuringLiveAnalysis>true</RunAnalyzersDuringLiveAnalysis>
<RunAnalyzersDuringBuild>true</RunAnalyzersDuringBuild>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<NoWarn>$(NoWarn);NU1507</NoWarn>
<NoWarn>$(NoWarn);CA1050</NoWarn> <!-- CA1050: Declare types in namespaces (using Root) -->

</PropertyGroup>

Expand Down
2 changes: 0 additions & 2 deletions src/_common/BinarySettings.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Binary on/off switches for high performance access
/// to behaviors and characteristics.
Expand Down
2 changes: 0 additions & 2 deletions src/_common/BufferLists/IBufferList.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Interface for adding input values to a buffered list.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Candles/Candles.Models.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// CANDLESTICK MODELS

/// <summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Candles/Candles.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Utility for candlestick data.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Enums.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Cache action instruction or outcome.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Generics/Pruning.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Utility for removing and pruning series data.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Generics/Seek.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides extension methods for seeking and finding elements in a series.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Generics/Sorting.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides extension methods for sorting a series of elements.
/// </summary>
Expand Down
3 changes: 0 additions & 3 deletions src/_common/Generics/StringOut.List.cs
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
using System.Reflection;
using System.Text;


namespace Skender.Stock.Indicators;

/// <summary>
/// Provides extension methods for converting ISeries lists to formatted strings.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Generics/StringOut.Type.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
using System.Text;
using System.Xml.Linq;

namespace Skender.Stock.Indicators;

/// <summary>
/// Provides extension methods for converting ISeries instances to formatted strings.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Generics/Transforms.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
using System.Collections.ObjectModel;

namespace Skender.Stock.Indicators;

/// <summary>
/// Provides extension methods for transforming collections.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/ISeries.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Time-series base interface.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Math/NullMath.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
using System.Runtime.CompilerServices;

namespace Skender.Stock.Indicators;

/// <summary>
/// Nullable <c>System.<see cref="Math"/></c> functions.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Math/Numerical.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

#pragma warning disable IDE0066 // Convert switch statement to expression
#pragma warning disable IDE0072 // Missing cases in switch statement

Expand Down
2 changes: 0 additions & 2 deletions src/_common/Observables/IStreamHub.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Streaming hub: management of observer
/// and observable indicator data
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Observables/IStreamObservable.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// STREAM (OBSERVABLE) INTERFACE

#region chain and quote variants
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Observables/IStreamObserver.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Management of observing + processing of streamed inbound data.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Observables/StreamHub.Observable.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// STREAM HUB (OBSERVABLE)

public abstract partial class StreamHub<TIn, TOut> : IStreamObservable<TOut>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Observables/StreamHub.Observer.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// STREAM HUB (OBSERVER)

public abstract partial class StreamHub<TIn, TOut> : IStreamObserver<TIn>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Observables/StreamHub.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides static utility methods for stream hub operations.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Observables/StreamHub.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

#pragma warning disable IDE0010 // Missing cases in switch expression

// STREAM HUB (BASE/CACHE)
Expand Down
2 changes: 0 additions & 2 deletions src/_common/ObsoleteV3.Indicators.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

#pragma warning disable CS1591 // Missing XML comments

namespace Skender.Stock.Indicators;

// OBSOLETE IN v3.0.0
public static partial class Indicator
{
Expand Down
2 changes: 0 additions & 2 deletions src/_common/ObsoleteV3.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
// ReSharper disable all
#pragma warning disable CS1591 // Missing XML comments

namespace Skender.Stock.Indicators;

// OBSOLETE IN v3.0.0
public static partial class Indicator
{
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Quotes/Quote.Aggregates.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// QUOTE UTILITIES

public static partial class Quotes
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Quotes/Quote.Converters.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides methods for manipulating and handling quote data.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Quotes/Quote.Exceptions.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Exception thrown when invalid quotes are encountered.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Quotes/Quote.Models.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// QUOTE MODELS

/// <summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Quotes/Quote.StreamHub.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

#region hub initializer

public static partial class Quotes
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Quotes/Quote.Validation.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
using System.Globalization;

namespace Skender.Stock.Indicators;

// QUOTE UTILITIES: VALIDATION

public static partial class Quotes
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Reusable/IReusable.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
using System.Text.Json.Serialization;

namespace Skender.Stock.Indicators;

/// <summary>
/// A time-series type that identifies
/// a single chainable value.
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Reusable/Reusable.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides utility methods for reusable types.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Use (QuotePart)/QuotePart.Models.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Chainable component part of an <see cref="IQuote"/>.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Use (QuotePart)/QuotePart.StaticSeries.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides extension methods for converting quotes to quote parts.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Use (QuotePart)/QuotePart.StreamHub.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// USE / QUOTE CONVERTER (STREAM HUB)

#region hub interface and initializer
Expand Down
2 changes: 0 additions & 2 deletions src/_common/Use (QuotePart)/QuotePart.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// QUOTEPART TYPE UTILITIES

public static partial class QuoteParts
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adl/Adl.Models.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Represents the result of the Accumulation/Distribution Line (ADL) indicator.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adl/Adl.StaticSeries.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides methods for calculating the Accumulation/Distribution Line (ADL).
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adl/Adl.StreamHub.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides methods for the Accumulation/Distribution Line (ADL) indicator.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adl/Adl.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

public static partial class Adl
{
/// <summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adx/Adx.BufferList.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Average Directional Index (ADX) from incremental reusable values.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adx/Adx.Models.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Represents the result of the ADX (Average Directional Index) calculation.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adx/Adx.StaticSeries.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides methods for calculating the Average Directional Index (ADX).
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adx/Adx.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides utility methods for the ADX (Average Directional Index) indicator.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Adx/IAdx.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Interface for Average Directional Index (ADX) streaming and buffered list.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Alligator/Alligator.Models.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Represents the result of the Alligator indicator calculation.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Alligator/Alligator.StaticSeries.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides methods for calculating the Williams Alligator indicator.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Alligator/Alligator.StreamHub.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

// WILLIAMS ALLIGATOR (STREAM HUB)

#region hub interface and initializer
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Alligator/Alligator.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides utility methods for the Williams Alligator indicator.
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Alma/Alma.Models.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Represents the result of the
/// ALMA (Arnaud Legoux Moving Average) calculation.
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Alma/Alma.StaticSeries.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides methods for calculating the Arnaud Legoux Moving Average (ALMA).
/// </summary>
Expand Down
2 changes: 0 additions & 2 deletions src/a-d/Alma/Alma.Utilities.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
namespace Skender.Stock.Indicators;

/// <summary>
/// Provides utility methods for the ALMA (Arnaud Legoux Moving Average) indicator.
/// </summary>
Expand Down
Loading
Loading