Class: Bioroebe::Permutations

Inherits:
CommandlineApplication show all
Defined in:
lib/bioroebe/utility_scripts/permutations.rb

Overview

Bioroebe::Permutations

Constant Summary

Constants inherited from CommandlineApplication

CommandlineApplication::OLD_VERBOSE_VALUE

Constants included from ColoursForBase

ColoursForBase::ARRAY_HTML_COLOURS_IN_USE

Constants inherited from Base

Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CommandlineApplication

#all_aminoacids?, #append_what_into, #at_home?, #be_silent, #be_verbose?, #cat, #ccliner, #change_directory, #cliner, #codon_table_dataset?, #codon_to_aminoacid, #codons_for?, #colourize_this_dna_sequence, #complement, #cp, #disable_warnings, #download_dir?, #editor?, #enable_warnings, #ensure_that_the_base_directories_exist, #esystem, #extract, #is_this_a_start_codon?, #is_this_a_stop_codon?, #leading_five_prime, #load_bioroebe_yaml_file, #log_directory?, #one_letter_to_long_name, #one_to_three, #only_numbers?, #open_in_browser, #opne, #opnn, #pad_with_double_quotes, #pad_with_single_quotes, #partner_nucleotide, #remove_numbers, #remove_trailing_ansii_escape_code, #return_all_possible_start_codons, #return_array_of_one_letter_aminoacids, #return_cheerful_person, #return_chunked_display, #return_ubiquitin_sequence, #set_be_verbose, #start_codon?, #stop_codons?, #strict_filter_away_invalid_aminoacids, #taxonomy_download_directory?, #three_to_one, #to_rna, #trailing_three_prime, #use_opn?, #verbose_truth, #was_or_were, #without_extname, #write_what_into

Methods included from CommandlineArguments

#commandline_arguments?, #commandline_arguments_that_are_files?, #e, #first?, #first_non_hyphen_argument?, #remove_hyphens_from_the_commandline_arguments, #return_commandline_arguments_as_string, #return_commandline_arguments_that_are_not_files, #return_entries_without_two_leading_hyphens, #select_commandline_arguments, #select_entries_starting_with_two_hyphens, #set_commandline_arguments

Methods included from ColoursForBase

#colourize_this_aminoacid_sequence_for_the_commandline, #colourize_this_nucleotide_sequence, #disable_colours, #ecomment, #efancy, #egold, #enable_colours, #eorange, #eparse, #erev, #red, #remove_trailing_escape_part, #return_colour_for_nucleotides, #rev, #sdir, #set_use_colours, #sfancy, #sfile, #simp, #swarn, #use_colours?, #use_colours_within_the_bioroebe_namespace?

Methods inherited from Base

#append_what_into, #can_base_pair?, #convert_global_env, #delete_file, #directory_to_the_codon_tables?, #file_readlines, #infer_the_namespace, #is_on_roebe?, #is_palindrome?, #main_encoding?, #mkdir, #move_file, #mv, #namespace?, #no_file_exists_at, #no_newlines, #project_yaml_directory?, #rds, #register_sigint, #return_pwd, #return_the_first_line_of_this_file, #word_wrap, #write_what_into

Constructor Details

#initialize(permutation_length = nil, run_already = true) ⇒ Permutations

#

initialize

#

33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 33

def initialize(
    permutation_length = nil,
    run_already        = true
  )
  reset
  set_permutation_length(
    permutation_length
  )
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

Bioroebe::Permutations[]

#

112
113
114
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 112

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

Instance Method Details

#permutation_length? ⇒ Boolean

#

permutation_length?

#

Returns:

  • (Boolean) 

73
74
75
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 73

def permutation_length?
  @permutation_length
end

#report ⇒ Object

#

report

#

105
106
107
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 105

def report
  e @result
end

#reset ⇒ Object

#

reset (reset tag)

#

47
48
49
50
51
52
53
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 47

def reset
  super()
  # ======================================================================= #
  # === @result
  # ======================================================================= #
  @result = ''.dup # Our result-String.
end

#result? ⇒ Boolean Also known as: result

#

result?

#

Returns:

  • (Boolean) 

80
81
82
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 80

def result?
  @result
end

#run ⇒ Object

#

run (run tag)

#

87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 87

def run
  array_integer_set = []
  permutation_length?.times { |n|
    array_integer_set << (n + 1)
  }
  all_permutations = array_integer_set.permutation.to_a
  _ = all_permutations.size # First output the number of Arrays holding permutations.
  # ======================================================================= #
  # First add how many permutations are possible.
  # ======================================================================= #
  @result << orange(_.to_s) << N
  all_permutations.each { |set| @result << set.join(' ')+N }
  report
end

#set_permutation_length(i = '') ⇒ Object

#

set_permutation_length

#

58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/bioroebe/utility_scripts/permutations.rb', line 58

def set_permutation_length(i = '')
  if i.nil?
    e 'Please provide a valid number as input to this class.'
  end
  i = i.first if i.is_a? Array
  if i and File.file?(i)
    i = File.read(i).strip
  end
  i = i.to_s.dup.to_i
  @permutation_length = i
end