6. Функции

План:
Функциите като черни кутии
Писане на функции
Коментари и документиране
Връщане на стойност и оператор return
Параметри на функции
Деклариране на функции
Странични ефекти и процедури
Параметри-псевдоними
Константни псевдоними
Област на действие на променливите, глобални променливи
Постъпково прецизиране, създаване на кода, проиграване

** Функциите като черни кутии

Функция е част от код, определен с име.
До сега сме използвали редица функции, които са предоставени:
-- от системните библиотеки на С++
    sqrt(x) - пресмята корен квадратен на числото с плаваща точка x
  getline(cin, s) - чете един ред от потока cin
-- като член-функции от класа string на Стандартната библиотека с шаблони на С++
    s.length() - връща дължината на низа s
--  като член-функции от потребителските класове Time и Employee, дефинирани в учебника
  t.get_second() - връща секундите от обекта t на класа Time

double future_value(double p)
 {  double b = 1000 * pow(1 + p / 100, 10);
    return b;
 }

// futval1.cpp
 #include <iostream>
 #include <cmath>
 using namespace std;
 
// дефиниция на функция
 double future_value(double p)
 {  double b = 1000 * pow(1 + p / 100, 10);
    return b;
 }
 
 int main()
 {  cout << "Please enter the interest rate in percent: ";
    double rate;
    cin >> rate;
 // извикване на функция
    double balance = future_value(rate);
    cout << "After 10 years, the balance is " 
         << balance << "\n";
 
    return 0;
 }

• Всяка функция трябва да бъде документирана, като преди да се пише самата функция, се записват коментари по зададен шаблон.
• В учебника е приет формата javadoc.

/**
   Computes the value of an investment with compound interest.
   @param initial_balance - the initial value of the investment
   @param p the interest rate per period in percent
   @param n the number of periods the investment is held
   @return the balance after n periods
*/
double future_value(double initial_balance, double p, int n)
{  double b = initial_balance * pow(1 + p / 100, n);
   return b;
}

 // approx.cpp

 #include <iostream>
 #include <algorithm>
 using namespace std;
 /**
    Tests whether two floating-point numbers are 
    approximately equal.
    @param x a floating-point number
    @param y another floating-point number
    @return true if x and y are approximately equal
 */
 bool approx_equal(double x, double y)
 {  
    const double EPSILON = 1E-14;
    if (x == 0) return fabs(y) <= EPSILON;
    if (y == 0) return fabs(x) <= EPSILON;
    return fabs(x - y) / max(fabs(x), fabs(y)) <= EPSILON;
 }
 
 int main()
 {  
    double x;
    cout << "Enter a number: ";
    cin >> x;
 
    double y;
    cout << "Enter another number: ";
    cin >> y;
 
    if (approx_equal(x, y))
       cout << "The numbers are approximately equal.\n";
    else
       cout << "The numbers are different.\n";
    return 0;
 }

** Параметри на функции

double future_value(double initial_balance, double p, int n)

b = future_value(total/2, rate, year2-year1);

• Външно забележимият ефект от работата на функция се нарича страничен ефект, напр. отпечатване на някакво съобщение, прекратяване работата на програмата и др.
• Функциите по принцип не трябва да имат странични ефекти, обикновено пресмятат нещо и връщат стойност. 
• Когато едно действие трябва да бъде извършено многократно (поне 2 пъти), има смисъл да бъде обособено като функция.
• Функция, която не връща стойност се нарича процедура. Всяка процедура има страничен ефект.

 // printime.cpp 

 #include <iostream>
 #include <iomanip>

 using namespace std;
 
 #include "ccc_time.h"
 /**
    Print a time in the format h:mm:ss
    @param t the time to print
 */
 void print_time(Time t)
 {  
    cout << t.get_hours() << ":" << setw(2) << setfill('0') 
         << t.get_minutes() << ":" << setw(2) 
         << t.get_seconds() << setfill(' ');
 }
 
 int main()
 {  
    Time liftoff(7, 0, 15);
    Time now;
    cout << "Liftoff: ";
    print_time(liftoff);
    cout << "\n";
 
    cout << "Now: ";
    print_time(now);
    cout << "\n";
 
    return 0;
 }

• Досега използваните параметри на функции сe наричат параметри-променливи.
• Параметрите-променливи са променливи, които се дефинират при извикване на функцията и са различни от променливите в извикващата функция.
• Параметър-псевдоним (reference parameter) не е нова променлива, а е друго име (псевдоним) на съществуваща променлива в извикващата функция.
• Всяка промяна на стойността на параметъра-псевдоним е промяна и на съответната променлива в извикващата функция.
  

Пример: Функция за увеличаване на заплата. 
Процедурата raise_salary увеличава заплатата на служител e с by процента. 

    raise_salary(harry, 5);

 // raisesal.cpp

 #include <iostream> 

 using namespace std;
 
 #include "ccc_empl.h"
 
 /**
    Raise an employee salary 
    @param e employee receiving raise
    @param by the percentage of the raise
 */
 void raise_salary(Employee& e, double by)
 {  
    double new_salary = e.get_salary() * (1 + by/100);
    e.set_salary(new_salary);
 }
 
 int main()
 {  
    Employee harry("Hacker, Harry", 45000.00);
    raise_salary(harry, 5);
    cout << "New salary: " << harry.get_salary() << "\n";

    return 0;
 }

• Формалният параметър Employee& e на функцията raise_salary е параметър-псевдоним на променливата harry от главната функция main.

• Промяната на стойността на параметъра-псевдоним e във функцията raise_salary води до промяна и на стойността на фактическия параметър (променливата) harry от функция main.

• Параметрите-псевдоними се наричат още входно-изходни параметри - те пренасят информация от извикващата функция към извиканата функция и обратно.

** Константни псевдоними

* Използват се за да се избегне копирането - особено нежелателно, ако параметърът е обект, съдържащ много данни.
* Тъй като стойността на константния псевдоним не може да се променя, той не "пренася" данни от извиканата функция (print_employee) в извикващата функция (main). 

Пример: Функция ца отпечатване на данните на обект от тип Employee
void print_employee(const Employee & e) 
{ 
 cout << "Name:   " << e.get_name() 
      << "Salary: " << e.get_salary(); 
}
 
int main()
{ 
   Employee harry("Hacker, Harry", 45000.00);
   print_employee(harry);

   return 0;
}

** Област на действие на променливите (scope), глобални променливи

* Ако едно и също име на променлива се използва в две функции,  то не съществува  връзка между двете променливи.
* Областта на действие на променлива, която е дефинирана в блока на функция, се простира единствено в рамките на тази функция. 

Пример: Сложна лихва - променливи с едно и също име в две функциии.

// futval1.cpp 
#include <iostream> 
#include <cmath> 
using namespace std;

double f_val(double i_bal, double p, int ny) /*дефиниции на параметрите-променливи i_bal, p и ny*/ 
{ 
  double r; /*дефиниция на променливата r в блока на функцията future_value*/ 
  r = i_bal*pow(1 + p/(12*100), 12*ny); 
  return r; 
} /*край на областта на действие на променливите i_bal, p, ny и r*/ 
int main() 
{ 
 cout << "Interest rate in percent: "; 
 double r; /*дефиниция на променливата r в блока на функцията main*/ 
 cin >> r; 
 double bal = f_val(1000, r, 10); /*дефиниция на променливата bal*/ 
 cout << "After 10 years, the balance is " << bal << "\n"; 
 return 0; 
} /* край на областта на действие на променливите r и bal*/

В примера няма връзка между двете променливи с име r в двете функции future_value и main. 

* Променлива, дефинирана в блок на функция, се нарича локална променлива.
* Областта на действие на локална променлива е от мястото на дефинирането до края на блока, в който е дефинирана променливата (block scope).
* В тази област променливата е видима, т.е. може да бъде използвана. 

* Променлива, дефинирана извън блок на функция, се нарича глобална променлива.
* Областта на действие на глобална променлива е от мястото на дефинирането до края на файла, в който е дефинирана променливата (file scope).
* Досега са използвани глобалните променливи (обекти) cin и cout, които са дефинирани в заглавния файл iostream.h. 

Пример: Увеличаване на заплата с глобална променлина.

// global.cpp

#include <iostream> 
using namespace std;

#include "ccc_empl.cpp"

double annual_raise; /* дефиниране на глобална променлива */ 

void raise_salary(Employee& e) 
{
  double new_salary = e.get_salary()
             *(1 + annual_raise/100);  /* използване на глобалната променлива */
  e.set_salary(new_salary); 
} 

int main() 
{ 
   Employee boss("Reindeer, Rudolf", 48000.00); 
   Employee harry("Hacker, Harry", 35000.00); 
   annual_raise = 5; /* използване на глобалната променлива */ 
   raise_salary(boss); 
   raise_salary(harry); 
   cout << boss.get_name() << " " << boss.get_salary() << "\n"; 
   cout << harry.get_name()<< " " << harry.get_salary()<< "\n";

   return 0; 
}

string digit_name(int n) 
/* ЦЕЛ:  превръща цифра в английското й име 
   ПОЛУЧАВА: n - цяло число между 1 и 9 
   ВРЪЩА:  името на n ("one" . . . "nine") 
*/ 
{  if (n == 1) return "one"; 
   else if (n == 2) return "two"; 
   else if (n == 3) return "three"; 
   else if (n == 4) return "four"; 
   else if (n == 5) return "five"; 
   else if (n == 6) return "six"; 
   else if (n == 7) return "seven"; 
   else if (n == 8) return "eight"; 
   else if (n == 9) return "nine"; 
   return ""; 
} 
string teen_name(int n) 
/* ЦЕЛ:  превръща цяло число между 10 и 19 в английското му име 
   ПОЛУЧАВА: n - цяло число между 10 и 19 
   ВРЪЩА:  името на n ("ten" . . . "nineteen") 
*/ 
{  if (n == 10) return "ten"; 
   else if (n == 11) return "eleven"; 
   else if (n == 12) return "twelve"; 
   else if (n == 13) return "thirteen"; 
   else if (n == 14) return "fourteen"; 
   else if (n == 15) return "fifteen"; 
   else if (n == 16) return "sixteen"; 
   else if (n == 17) return "seventeen"; 
   else if (n == 18) return "eighteen"; 
   else if (n == 19) return "nineteen"; 
   return ""; 
} 
string tens_name(int n) 
/* ЦЕЛ:  дава английското име на десетиците между 20 и 90 
   ПОЛУЧАВА: n - цяло число между 2 и 9 
   ВРЪЩА:  името на 10*n ("twenty" . . . "ninety") 
*/ 
{  if (n == 2) return "twenty"; 
   else if (n == 3) return "thirty"; 
   else if (n == 4) return "forty"; 
   else if (n == 5) return "fifty"; 
   else if (n == 6) return "sixty"; 
   else if (n == 7) return "seventy"; 
   else if (n == 8) return "eighty"; 
   else if (n == 9) return "ninety"; 
   return ""; 
} 
string int_name(int n) 
/* ЦЕЛ:  превръща цяло число в английското му име 
   ПОЛУЧАВА: n - цяло положително число < 1000000 
   ВРЪЩА:  името на n (т.е. "two hundred seventy four") 
*/ 
{  int c = n; /* оставащата за превръщане част */ 
   string r;  /* стойността на функцията */ 
   if (c >= 1000) 
   {  r = int_name(c / 1000) + " thousand"; 
      c = c % 1000; 
   } 
   if (c >= 100) 
   {  r = r + " " + digit_name(c / 100) + " hundred"; 
      c = c % 100; 
   } 
   if (c >= 20) 
   {  r = r + " " + tens_name(c / 10); 
      c = c % 10; 
   } 
   else if (c >= 10) 
   {  r = r + " " + teen_name(c); 
      c = 0; 
   } 
   if (c > 0) 
      r = r + " " + digit_name(c); 
   return r; 
} 
int main() 
{  int n; 
   cout << "Please enter a positive integer: "; 
   cin >> n; 
   cout << int_name(n); 
   return 0; 
}