Class: Sevgi::Sundries::Ruler

Inherits:
Interval
  • Object
show all
Defined in:
lib/sevgi/sundries/ruler.rb

Overview

Fits a repeated interval into a broader span with computed margins.

A ruler stores both the fitted major interval and the source subinterval. The compact reader names mirror Interval: brut is the full available span, sd/su/sn describe the subinterval, and waste is distributed as equal margins.

Examples:

Ruler geometry

# <--------- d = n x sd ---------><--- waste = 2 x margin --->
# <----- u = unit x multiple ----->
# <---------------- brut ---------------->
ruler = Sevgi::Sundries::Ruler.new(unit: 1, multiple: 10, brut: 150)
ruler.d # => 150.0

Direct Known Subclasses

Grid::Axis, RulerEven

Instance Attribute Summary collapse

Attributes inherited from Interval

#n, #u

Instance Method Summary collapse

Methods inherited from Interval

[], #[], #count, #d, #ds, #h, #hs, #nds, #nhs

Constructor Details

#initialize(brut:, unit:, multiple:, margin: 0.0) ⇒ void

Creates a ruler fitted into the given span.

Parameters:

  • brut (Numeric) —

    full available span

  • unit (Numeric) —

    subinterval unit length

  • multiple (Integer) —

    number of subinterval units per major interval

  • margin (Numeric) (defaults to: 0.0) —

    minimum margin on each side

Raises:

  • (Sevgi::ArgumentError) —

    when brut is not numeric

  • (Sevgi::ArgumentError) —

    when brut is not finite

  • (Sevgi::ArgumentError) —

    when brut is negative

  • (Sevgi::ArgumentError) —

    when unit is not numeric

  • (Sevgi::ArgumentError) —

    when unit is not finite

  • (Sevgi::ArgumentError) —

    when unit is not positive

  • (Sevgi::ArgumentError) —

    when multiple is not a positive integer

  • (Sevgi::ArgumentError) —

    when margin is not numeric

  • (Sevgi::ArgumentError) —

    when margin is not finite

  • (Sevgi::ArgumentError) —

    when margin is negative

  • (Sevgi::ArgumentError) —

    when the fitting span is negative



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/sevgi/sundries/ruler.rb', line 176

def initialize(brut:, unit:, multiple:, margin: 0.0)
  @brut = non_negative_number(brut, "Ruler brut")
  unit = positive_number(unit, "Ruler unit")
  multiple = positive_integer(multiple, "Ruler multiple")
  margin = non_negative_number(margin, "Ruler margin")
  @sub = Interval.new(unit, multiple)

  n = divide(unit:, multiple:, brut: @brut, margin:)

  ArgumentError.("Ruler fitting span must not be negative") if n.negative?

  super(@sub, n)
end

Instance Attribute Details

#brut ⇒ Float (readonly)

Returns full available span before fitting.

Returns:

  • (Float) —

    full available span before fitting



157
158
159
 
# File 'lib/sevgi/sundries/ruler.rb', line 157

def brut
  @brut
end

#sub ⇒ Object (readonly)

Returns the value of attribute sub.



157
 
# File 'lib/sevgi/sundries/ruler.rb', line 157

attr_reader :brut, :sub

Instance Method Details

#expand ⇒ Sevgi::Sundries::Ruler

Returns a ruler where the source subinterval is flattened into units.

Returns:



192
 
# File 'lib/sevgi/sundries/ruler.rb', line 192

def expand = self.class.new(unit: sub.u, multiple: 1, brut: d + waste, margin:)

#margin ⇒ Float

Returns the computed margin after fitting.

Returns:

  • (Float) 


196
 
# File 'lib/sevgi/sundries/ruler.rb', line 196

def margin = @margin ||= waste / 2.0

#ms ⇒ Array<Float>

Returns minor tick distances across the fitted span.

Returns:

  • (Array<Float>) 


200
 
# File 'lib/sevgi/sundries/ruler.rb', line 200

def ms = @ms ||= expand.ds

#sd ⇒ Float

Returns the source subinterval distance.

Returns:

  • (Float) 


212
 
# File 'lib/sevgi/sundries/ruler.rb', line 212

def sd = @sub.d

#sn ⇒ Integer

Returns the source subinterval count.

Returns:

  • (Integer) 


208
 
# File 'lib/sevgi/sundries/ruler.rb', line 208

def sn = @sub.n

#su ⇒ Float

Returns the source subinterval unit length.

Returns:

  • (Float) 


216
 
# File 'lib/sevgi/sundries/ruler.rb', line 216

def su = @sub.u

#waste ⇒ Float

Returns the unfitted distance distributed outside the fitted span.

Returns:

  • (Float) 


204
 
# File 'lib/sevgi/sundries/ruler.rb', line 204

def waste = @waste ||= brut - d