ðŸŽ‰ Exercism Research is now launched. Help Exercism, help science and have some fun at research.exercism.io ðŸŽ‰

Published at Jul 13 2018
·
0 comments

Instructions

Test suite

Solution

Implement a binary search algorithm.

Searching a sorted collection is a common task. A dictionary is a sorted list of word definitions. Given a word, one can find its definition. A telephone book is a sorted list of people's names, addresses, and telephone numbers. Knowing someone's name allows one to quickly find their telephone number and address.

If the list to be searched contains more than a few items (a dozen, say) a binary search will require far fewer comparisons than a linear search, but it imposes the requirement that the list be sorted.

In computer science, a binary search or half-interval search algorithm finds the position of a specified input value (the search "key") within an array sorted by key value.

In each step, the algorithm compares the search key value with the key value of the middle element of the array.

If the keys match, then a matching element has been found and its index, or position, is returned.

Otherwise, if the search key is less than the middle element's key, then the algorithm repeats its action on the sub-array to the left of the middle element or, if the search key is greater, on the sub-array to the right.

If the remaining array to be searched is empty, then the key cannot be found in the array and a special "not found" indication is returned.

A binary search halves the number of items to check with each iteration, so locating an item (or determining its absence) takes logarithmic time. A binary search is a dichotomic divide and conquer search algorithm.

Make sure you have read the C page on the Exercism site. This covers the basic information on setting up the development environment expected by the exercises.

Get the first test compiling, linking and passing by following the three rules of test-driven development.

The included makefile can be used to create and run the tests using the `test`

task.

```
make test
```

Create just the functions you need to satisfy any compiler errors and get the test to fail. Then write just enough code to get the test to pass. Once you've done that, move onto the next test.

As you progress through the tests, take the time to refactor your implementation for readability and expressiveness and then go on to the next test.

Try to use standard C99 facilities in preference to writing your own low-level algorithms or facilities by hand.

Wikipedia http://en.wikipedia.org/wiki/Binary_search_algorithm

It's possible to submit an incomplete solution so you can see how others have completed the exercise.

```
#include "vendor/unity.h"
#include "../src/binary_search.h"
void setUp(void)
{
}
void tearDown(void)
{
}
void test_single_element(void)
{
int arr[] = { 6 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(&arr[0], binary_search(6, arr, length));
}
void test_value_in_middle(void)
{
TEST_IGNORE(); // delete this line to run test
int arr[] = { 1, 3, 4, 6, 8, 9, 11 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(&arr[3], binary_search(6, arr, length));
}
void test_value_at_beginning(void)
{
TEST_IGNORE();
int arr[] = { 1, 3, 4, 6, 8, 9, 11 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(&arr[0], binary_search(1, arr, length));
}
void test_value_at_end(void)
{
TEST_IGNORE();
int arr[] = { 1, 3, 4, 6, 8, 9, 11 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(&arr[6], binary_search(11, arr, length));
}
void test_find_value_with_odd_length(void)
{
TEST_IGNORE();
int arr[] = { 1, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 634 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(&arr[9], binary_search(144, arr, length));
}
void test_find_value_with_even_length(void)
{
TEST_IGNORE();
int arr[] = { 1, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(&arr[5], binary_search(21, arr, length));
}
void test_identify_missing_value(void)
{
TEST_IGNORE();
int arr[] = { 1, 3, 4, 6, 8, 9, 11 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(NULL, binary_search(7, arr, length));
}
void test_value_smaller_than_everything(void)
{
TEST_IGNORE();
int arr[] = { 1, 3, 4, 6, 8, 9, 11 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(NULL, binary_search(0, arr, length));
}
void test_value_larger_than_everything(void)
{
TEST_IGNORE();
int arr[] = { 1, 3, 4, 6, 8, 9, 11 };
size_t length = sizeof(arr) / sizeof(arr[0]);
TEST_ASSERT_EQUAL_PTR(NULL, binary_search(13, arr, length));
}
void test_empty_array(void)
{
TEST_IGNORE();
int *arr = NULL;
size_t length = 0;
TEST_ASSERT_EQUAL_PTR(NULL, binary_search(1, arr, length));
}
void test_zero_length_array(void)
{
TEST_IGNORE();
int arr[] = { 1 };
size_t length = 0;
TEST_ASSERT_EQUAL_PTR(NULL, binary_search(1, arr, length));
}
int main(void)
{
UnityBegin("test/test_binary_search.c");
RUN_TEST(test_single_element);
RUN_TEST(test_value_in_middle);
RUN_TEST(test_value_at_beginning);
RUN_TEST(test_value_at_end);
RUN_TEST(test_find_value_with_odd_length);
RUN_TEST(test_find_value_with_even_length);
RUN_TEST(test_identify_missing_value);
RUN_TEST(test_value_smaller_than_everything);
RUN_TEST(test_value_larger_than_everything);
RUN_TEST(test_empty_array);
RUN_TEST(test_zero_length_array);
UnityEnd();
return 0;
}
```

```
#include "binary_search.h"
#include <stddef.h>
int* binary_search(const int x, const int arr[], const int len)
{
if (arr == NULL)
return NULL;
int down, up, mid;
down = 0;
up = len - 1;
while (down <= up) {
mid = (up + down) /2;
if (x == arr[mid])
return (int *) &arr[mid];
if (x > arr[mid])
down = mid + 1;
else
up = mid - 1;
}
return NULL;
}
```

```
#ifndef BIN_SEARCH_H
#define BIN_SEARCH_H
int* binary_search(const int x, const int arr[], const int len);
#endif
```

A huge amount can be learned from reading other peopleâ€™s code. This is why we wanted to give exercism users the option of making their solutions public.

Here are some questions to help you reflect on this solution and learn the most from it.

- What compromises have been made?
- Are there new concepts here that you could read more about to improve your understanding?

Level up your programming skills with 3,449 exercises across 52 languages, and insightful discussion with our volunteer team of welcoming mentors.
Exercism is
**100% free forever**.

## Community comments