ensembl-hive  2.1
 All Classes Namespaces Files Functions Pages
Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply Class Reference
+ Inheritance diagram for Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply:
+ Collaboration diagram for Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply:

Public Member Functions

public param_defaults ()
 
public fetch_input ()
 
public run ()
 
public write_output ()
 
protected _rec_multiply ()
 
- Public Member Functions inherited from Bio::EnsEMBL::Hive::Process
public new ()
 
public life_cycle ()
 
public say_with_header ()
 
public enter_status ()
 
public warning ()
 
public strict_hash_format ()
 
public param_defaults ()
 
public fetch_input ()
 
public run ()
 
public write_output ()
 
public Bio::EnsEMBL::Hive::Worker worker ()
 
public Boolean execute_writes ()
 
public
Bio::EnsEMBL::Hive::DBSQL::DBAdaptor 
db ()
 
public
Bio::EnsEMBL::Hive::DBSQL::DBConnection 
dbc ()
 
public
Bio::EnsEMBL::Hive::DBSQL::DBConnection 
data_dbc ()
 
public
Bio::EnsEMBL::Hive::AnalysisJob 
input_job ()
 
public input_id ()
 
public param ()
 
public param_required ()
 
public param_is_defined ()
 
public param_substitute ()
 
public dataflow_output_id ()
 
public throw ()
 
public complete_early ()
 
public Int debug ()
 
public worker_temp_directory ()
 
public worker_temp_directory_name ()
 
public cleanup_worker_temp_directory ()
 

Detailed Description

Synopsis

Please refer to Bio::EnsEMBL::Hive::PipeConfig::LongMult_conf pipeline configuration file
to understand how this particular example pipeline is configured and ran.

Description

    'LongMult::PartMultiply' has a separate task of multiplying 'a_multiplier' by the given 'digit',
    then it passes its partial_product on.

Member Function Documentation

protected Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply::_rec_multiply ( )
    
    Description: this is a private function (not a method) that performs recursive multiplication of a long number by a digit with a carry.
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply::fetch_input ( )
    Description : Implements fetch_input() interface method of Bio::EnsEMBL::Hive::Process that is used to read in parameters and load data.
                  Here we have nothing to fetch.
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply::param_defaults ( )
    Description : Implements param_defaults() interface method of Bio::EnsEMBL::Hive::Process that defines module defaults for parameters.
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply::run ( )
    Description : Implements run() interface method of Bio::EnsEMBL::Hive::Process that is used to perform the main bulk of the job (minus input and output).
                  The only thing we do here is make a call to the recursive function that will compute the product.
    param('a_multiplier'):  The first long number (a string of digits - doesn't have to fit a register).
    param('digit'):         A decimal digit that is a part of the second multiplier.
    param('take_time'):     How much time to spend sleeping (seconds).
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::PartMultiply::write_output ( )
    Description : Implements write_output() interface method of Bio::EnsEMBL::Hive::Process that is used to deal with job's output after the execution.
                  Dataflows the intermediate results down branch 1, which will be routed into 'partial_product' accumulator.
 
Code:
click to view

The documentation for this class was generated from the following file: