Class: Roebe::EuclidianDistance

Inherits:
Base show all
Defined in:
lib/roebe/classes/euclidian_distance.rb

Overview

EuclidianDistance.new

Constant Summary collapse

POINT_1 =
#

POINT_1

#
[ 2, 3, -1 ]
POINT_2 =
#

POINT_2

#
[ 4, 1, -2 ]

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(i = nil, run_already = true) ⇒ EuclidianDistance

#

initialize

#


38
39
40
41
42
43
44
45
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 38

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_the_two_points_to_compare(i)
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

[]

#


140
141
142
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 140

def self.[](i = '')
  self.new(i)
end

Instance Method Details

#calculate_the_euclidean_distance(first_point = nil, second_point = nil) ⇒ Object

#

calculate_the_euclidean_distance

Pass in the two Arrays that represent the two points p and q in a three-dimensional space.

Invocation example:

puts calculate_the_euclidean_distance([2,3,-1], [4,1,-2])
#


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 63

def calculate_the_euclidean_distance(
    first_point  = nil,
    second_point = nil
  )
  if first_point.nil?
    first_point = first_point?
  end
  if second_point.nil?
    second_point = second_point?
  end
  difference = (
    ((second_point[0] - first_point[0]) ** 2) +
    ((second_point[1] - first_point[1]) ** 2) +
    ((second_point[2] - first_point[2]) ** 2)
  )
  result = Math.sqrt(difference)
  return result
end

#first_point? ⇒ Boolean

#

first_point

#

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 85

def first_point?
  @the_two_points_to_compare.first
end

#report_the_euclidean_distance(distance) ⇒ Object

#

report_the_euclidean_distance

#


128
129
130
131
132
133
134
135
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 128

def report_the_euclidean_distance(distance)
  e 'The euclidian distance between the two '\
    'points ['+
    royalblue(first_point?.join(','))+
    '] and ['+
    royalblue(second_point?.join(','))+
    '] is '+orange(distance)+'.'
end

#reset ⇒ Object

#

reset (reset tag)

#


50
51
52
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 50

def reset
  super()
end

#run ⇒ Object

#

run (run tag)

#


120
121
122
123
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 120

def run
  _ = calculate_the_euclidean_distance
  report_the_euclidean_distance(_)
end

#second_point? ⇒ Boolean

#

second_point?

#

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 92

def second_point?
  @the_two_points_to_compare.last
end

#set_the_two_points_to_compare(i = []) ⇒ Object

#

set_the_two_points_to_compare

#


99
100
101
102
103
104
105
106
107
108
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 99

def set_the_two_points_to_compare(i = [])
  unless i.is_a? Array
    i = [i]
  end
  if i.empty?
    i << POINT_1
    i << POINT_2
  end
  @the_two_points_to_compare = i
end

#the_two_points_to_compare? ⇒ Boolean

#

the_two_points_to_compare?

#

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/roebe/classes/euclidian_distance.rb', line 113

def the_two_points_to_compare?
  @the_two_points_to_compare
end