Проєктування інтерфейсу функцій

Покрокове проєктування інтерфейсу

Розгляньмо функцію скорочення дробу. Початкове формулювання «скоротити числа a і b» залишає кілька питань: чи може знаменник дорівнювати нулю, де зберігати знак, чи допустимий нульовий чисельник, чи потрібно змінювати аргументи. Відповіді визначають інтерфейс ще до вибору алгоритму Евкліда. Для навчального варіанта можна вимагати додатний знаменник і невід’ємний чисельник, а результат повертати структурою з полями numerator і denominator.

Тоді reduce(0,7) має повернути 0/1, а reduce(6,8) – 3/4. Обчислення НСД є окремою функцією, яку можна перевірити на парах із однаковими числами та взаємно простими числами. Функція скорочення не має читати клавіатуру: це зробить main, перевірить знаменник і передасть уже коректні числа. Так один обчислювальний інтерфейс працюватиме і для argv, і для інтерактивного режиму.

Альтернативний інтерфейс void reduce(int& numerator, int& denominator) змінює існуючі змінні. Він теж можливий, але виклик має чітко повідомляти про зміну. Передавання тієї самої змінної в обидва параметри створює додатковий випадок, який доведеться визначити або заборонити передумовою. Повернення структури прибирає цю приховану залежність між вихідними параметрами.

Вибір перевантаження вручну

Щоб зрозуміти повідомлення компілятора, спочатку випишіть набір кандидатів. Для area(double) і area(double,double) виклик area(2) має лише один кандидат за кількістю аргументів; ціле 2 перетворюється на double. Для пари calculate(int) і calculate(double) виклик calculate(2) точно відповідає першому, а calculate(2.0) – другому. Назва зовнішньої змінної не впливає на цей вибір.

Якщо є calculate(long) і calculate(double), аргумент типу int може потребувати перетворення в обох випадках, і вибір здатен бути неоднозначним. Не додавайте випадкові приведення типу, доки не з’ясовано, яку семантику очікував виклик. Можливо, інтерфейс повинен мати різні імена, наприклад count_items і measure_length, бо дії концептуально різні.

Для аргументів за замовчуванням корисно виписати допустимі форми виклику. Функція price(double amount,double rate=0.2) дозволяє один або два аргументи. Додавання іншої price(double) створює конкуренцію для виклику з одним аргументом. Правило «менше написано – краще» тут не працює: інтерфейс має залишатися однозначним.

Рекурсивний виклик як окремий екземпляр

Початківець іноді уявляє, що рекурсивна функція має одну змінну n для всіх рівнів. Насправді кожний виклик створює власний параметр. Для факторіала 3 зовнішній виклик пам’ятає n=3, поки внутрішній працює з n=2. Коли останній поверне 2, зовнішній домножить на власну 3. Локальні імена однакові, але об’єкти різні.

Саме тому в налагоджувачі важливо вибрати кадр Call Stack перед переглядом Locals. Значення n=1 у поточному кадрі не означає, що всі попередні кадри теж стали 1. Для параметра-посилання на загальний лічильник картина інша: кадри мають доступ до одного зовнішнього об’єкта. Порівняння цих випадків на Ханойських вежах показує різницю копії й спільного стану.

Рекурсивний алгоритм часто можна замінити ітерацією, але потрібно відтворити стан, який зберігався у кадрах. Для факторіала достатньо накопичувача і лічильника. Для обходу дерева потрібна колекція відкладених вузлів. Тому вибір рекурсії має спиратися на форму задачі та обмеження ресурсів, а не лише на кількість рядків програми.

Контроль вартості обчислення

Лічильник викликів і максимальна глибина вимірюють різні речі. На вході до функції можна збільшувати лічильник і порівнювати поточну глибину з максимальною. На виході поточну глибину потрібно зменшити на кожному шляху, включно з базовим випадком. Якщо один ранній return пропущено, діагностичний лічильник сам стане неправильним.

Для навчальних завдань з експоненційною кількістю викликів встановлюйте малий допустимий вхід. Збільшення типу int до long long усуває лише деякі обмеження значень, але не робить мільярди викликів швидкими. Вимірювання часу на одному малому прикладі також не замінює оцінки того, як робота зростає з розміром входу.

Відтворюваний приклад помилки інтерфейсу

Коли функція повертає неправильну відповідь, спочатку відокремте її від великої програми. Запишіть найменший набір аргументів, на якому видно розбіжність. Наприклад, якщо нормалізація часу неправильна для великих секунд, достатньо виклику з годинами 0, хвилинами 0 і секундами 60. Очікується 0:1:0. Якщо виходить 0:0:60, перевірте передавання за посиланням; якщо 0:1:60 – забуто обчислення остачі.

Мінімальний приклад має зберігати типи, порядок викликів і потрібні налаштування, але не потребує всього меню, файлів або графічного інтерфейсу. Його можна додати до README як регресійний випадок: після виправлення повторити, щоб помилка не повернулася. Для функцій із прихованою static-змінною одного виклику іноді недостатньо: потрібно також відтворити попередні виклики, які сформували стан.

При налагодженні не змінюйте одночасно і алгоритм, і типи, і тестові дані. Спершу перевірте фактичні аргументи на вході. Потім виконайте один крок функції, порівняйте локальні значення з ручним розрахунком і знайдіть першу точку розбіжності. Помилка на вході може бути наслідком переплутаного порядку аргументів у викликача, а не формули всередині.

Результат виправлення пояснюйте через поведінку: «функція тепер змінює оригінальні компоненти, бо параметри є посиланнями», а не лише «додано символ &». Так пояснення залишається корисним при перенесенні ідеї до іншої функції. Зв’язок між інтерфейсом, передумовами та тестом є основою подальшого проєктування класів і бібліотек.

Документування обчислювальної функції

Коментар перед функцією має повідомляти те, чого не видно з її тіла. Для площі це одиниці довжин і результату, допустимі аргументи та політика помилок. Для сортування – чи змінюється початкова послідовність, як порівнюються рівні елементи і чи потрібні різні об’єкти для всіх параметрів-посилань. Перелік таких умов є практичним контрактом інтерфейсу навіть без спеціального мовного механізму контрактів.

Порівняйте два можливі результати пошуку кореня. Повернення лише double не пояснює, чи метод збіжний і наскільки мала нев’язка. Структура з полями root, iterations і converged дозволяє викликачеві прийняти обґрунтоване рішення. Водночас не потрібно додавати десятки полів «на майбутнє»: поверніть лише дані, потрібні поточним сценаріям використання.

Параметри за замовчуванням також документують припущення. Якщо точність бісекції типово дорівнює 1e-6, слід пояснити, чи це довжина інтервалу, модуль нев’язки або відносна похибка. Одне число з назвою epsilon без пояснення не визначає надійного алгоритму. Коли різні функції використовують різні критерії, однакове ім’я параметра може вводити в оману.

Під час захисту покажіть один приклад виклику кожної відкритої функції та поясніть, чому аргументи задовольняють передумови. Потім наведіть один недопустимий випадок і місце, де його відхиляє програма. Так можна відрізнити випадково працюючий код від інтерфейсу, який автор розуміє і може безпечно використати повторно.

Типові помилки

Таблиця 3.1. Помилки інтерфейсів і викликів

Ситуація	Пояснення та виправлення
Після виклику число незмінне	Параметр є копією; поверніть результат або свідомо використайте посилання.
Функцію не знайдено	Перевірте видиме оголошення до виклику і відповідне визначення серед файлів проєкту.
Неоднозначне перевантаження	Уточніть тип аргументу або спростіть набір функцій і типових аргументів.
Посилання на локальну змінну	Об’єкт знищено після повернення; повертайте власне значення.
Нескінченна рекурсія	Перевірте базу, допустимий вхід і зменшення задачі на кожному шляху.
Довільний argv без перевірки	Перевірте argc до індексації, а потім повноту числового розбору.