sqa 0.0.31 → 0.0.37

data/docs/api-reference/sqa_multitimeframe.md

@@ -0,0 +1,227 @@
+# 📦 SQA::MultiTimeframe
+
+!!! note "Description"
+    MultiTimeframe - Analyze patterns across multiple timeframes
+    
+    Provides methods for:
+    - Timeframe conversion (daily → weekly → monthly)
+    - Multi-timeframe signal confirmation
+    - Trend alignment across timeframes
+    - Support/resistance across timeframes
+    
+    Common timeframe strategy:
+    - Use higher timeframe for trend direction
+    - Use lower timeframe for entry timing
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/multi_timeframe.rb:23`
+    
+    **Inherits from:** `Object`
+
+## 🔨 Instance Methods
+
+### `#stock()`
+
+Returns the value of attribute stock.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:24`
+
+---
+
+### `#timeframes()`
+
+Returns the value of attribute timeframes.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:24`
+
+---
+
+### `#initialize(stock:)`
+
+Initialize multi-timeframe analyzer
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `stock` | `SQA::Stock` | Stock object with daily data |
+!!! success "Returns"
+
+    **Type:** `MultiTimeframe`
+
+    
+
+    a new instance of MultiTimeframe
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:31`
+
+---
+
+### `#convert_timeframes()`
+
+Convert daily data to weekly and monthly
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:42`
+
+---
+
+### `#trend_alignment(lookback: = 20)`
+
+Check trend alignment across timeframes
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `lookback` | `Integer` | Periods to look back for trend |
+!!! success "Returns"
+
+    **Type:** `Hash`
+
+    
+
+    Trend direction for each timeframe
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:56`
+
+---
+
+### `#signal(strategy_class:, higher_timeframe: = :weekly, lower_timeframe: = :daily)`
+
+Generate multi-timeframe signal
+
+Uses higher timeframe for trend, lower for timing.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `strategy_class` | `Class` | Strategy to apply |
+    | `higher_timeframe` | `Symbol` | Timeframe for trend (:weekly, :monthly) |
+    | `lower_timeframe` | `Symbol` | Timeframe for entry (:daily, :weekly) |
+!!! success "Returns"
+
+    **Type:** `Symbol`
+
+    
+
+    :buy, :sell, or :hold
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:102`
+
+---
+
+### `#support_resistance(tolerance: = 0.02)`
+
+Find support/resistance levels across timeframes
+
+Levels that appear on multiple timeframes are stronger.
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `tolerance` | `Float` | Price tolerance for matching levels (default: 0.02 for 2%) |
+!!! success "Returns"
+
+    **Type:** `Hash`
+
+    
+
+    Support and resistance levels
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:138`
+
+---
+
+### `#indicators(indicator:, **options)`
+
+Calculate indicators for each timeframe
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `indicator` | `Symbol` | Indicator to calculate |
+    | `options` | `Hash` | Indicator options |
+!!! success "Returns"
+
+    **Type:** `Hash`
+
+    
+
+    Indicator values for each timeframe
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:167`
+
+---
+
+### `#detect_divergence()`
+
+Detect divergence across timeframes
+
+Divergence occurs when price and indicator move in opposite directions.
+
+
+!!! success "Returns"
+
+    **Type:** `Hash`
+
+    
+
+    Divergence information
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:197`
+
+---
+
+### `#confirmation(strategy_class:)`
+
+Check if timeframes confirm each other
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `strategy_class` | `Class` | Strategy to use |
+!!! success "Returns"
+
+    **Type:** `Hash`
+
+    
+
+    Confirmation status
+
+??? info "Source Location"
+    `lib/sqa/multi_timeframe.rb:228`
+
+---
+
+## 📝 Attributes
+
+### 👁️ `stock` <small>read-only</small>
+
+Returns the value of attribute stock.
+
+### 👁️ `timeframes` <small>read-only</small>
+
+Returns the value of attribute timeframes.
+

data/docs/api-reference/sqa_patternmatcher.md

@@ -0,0 +1,195 @@
+# 📦 SQA::PatternMatcher
+
+!!! note "Description"
+    PatternMatcher - Find similar historical patterns
+    
+    Provides methods for:
+    - Pattern similarity search (nearest-neighbor)
+    - Shape-based pattern matching
+    - Predict future moves based on similar past patterns
+    - Pattern clustering
+    
+    Uses techniques:
+    - Euclidean distance
+    - Dynamic Time Warping (DTW)
+    - Pearson correlation
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/pattern_matcher.rb:24`
+    
+    **Inherits from:** `Object`
+
+## 🔨 Instance Methods
+
+### `#stock()`
+
+Returns the value of attribute stock.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:25`
+
+---
+
+### `#prices()`
+
+Returns the value of attribute prices.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:25`
+
+---
+
+### `#initialize(stock:)`
+
+Initialize pattern matcher
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `stock` | `SQA::Stock` | Stock object |
+!!! success "Returns"
+
+    **Type:** `PatternMatcher`
+
+    
+
+    a new instance of PatternMatcher
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:32`
+
+---
+
+### `#find_similar(lookback: = 10, num_matches: = 5, method: = :euclidean, normalize: = true)`
+
+Find similar historical patterns to current pattern
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `lookback` | `Integer` | Pattern length (days) |
+    | `num_matches` | `Integer` | Number of similar patterns to find |
+    | `method` | `Symbol` | Distance method (:euclidean, :dtw, :correlation) |
+    | `normalize` | `Boolean` | Normalize patterns before comparison |
+!!! success "Returns"
+
+    **Type:** `Array<Hash>`
+
+    
+
+    Similar patterns with metadata
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:46`
+
+---
+
+### `#forecast(lookback: = 10, forecast_periods: = 5, num_matches: = 10)`
+
+Predict future price movement based on similar patterns
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `lookback` | `Integer` | Pattern length |
+    | `forecast_periods` | `Integer` | Periods to forecast |
+    | `num_matches` | `Integer` | Number of similar patterns to use |
+!!! success "Returns"
+
+    **Type:** `Hash`
+
+    
+
+    Forecast with confidence intervals
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:107`
+
+---
+
+### `#detect_chart_pattern(pattern_type)`
+
+Detect chart patterns (head & shoulders, double top, etc.)
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `pattern_type` | `Symbol` | Pattern to detect |
+!!! success "Returns"
+
+    **Type:** `Array<Hash>`
+
+    
+
+    Detected patterns
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:141`
+
+---
+
+### `#cluster_patterns(pattern_length: = 10, num_clusters: = 5)`
+
+Cluster patterns by similarity
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `pattern_length` | `Integer` | Length of patterns |
+    | `num_clusters` | `Integer` | Number of clusters |
+!!! success "Returns"
+
+    **Type:** `Array<Array<Hash>>`
+
+    
+
+    Clusters of similar patterns
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:163`
+
+---
+
+### `#pattern_quality(pattern)`
+
+Calculate pattern strength/quality
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `pattern` | `Array<Float>` | Price pattern |
+!!! success "Returns"
+
+    **Type:** `Hash`
+
+    
+
+    Pattern quality metrics
+
+??? info "Source Location"
+    `lib/sqa/pattern_matcher.rb:214`
+
+---
+
+## 📝 Attributes
+
+### 👁️ `stock` <small>read-only</small>
+
+Returns the value of attribute stock.
+
+### 👁️ `prices` <small>read-only</small>
+
+Returns the value of attribute prices.
+

data/docs/api-reference/sqa_pluginmanager.md

@@ -0,0 +1,55 @@
+# 📦 SQA::PluginManager
+
+!!! abstract "Source Information"
+    **Defined in:** `lib/sqa/plugin_manager.rb:7`
+    
+    **Inherits from:** `Object`
+
+## 🏭 Class Methods
+
+### `.registered_properties()`
+
+Returns the value of attribute registered_properties.
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/plugin_manager.rb:11`
+
+---
+
+### `.registered_properties=(value)`
+
+Sets the attribute registered_properties
+
+!!! info "Parameters"
+
+    | Name | Type | Description |
+    |------|------|-------------|
+    | `value` | `Any` | the value to set the attribute registered_properties to. |
+
+
+??? info "Source Location"
+    `lib/sqa/plugin_manager.rb:11`
+
+---
+
+### `.new_property(name, options = {})`
+
+name (Symbol)
+
+
+
+
+??? info "Source Location"
+    `lib/sqa/plugin_manager.rb:15`
+
+---
+
+## 📝 Attributes
+
+### 🔄 `registered_properties` <small>read/write</small>
+
+Returns the value of attribute registered_properties.
+