X-Git-Url: https://git.cworth.org/git?p=mnemon;a=blobdiff_plain;f=mnemon.c;h=db8f62fe87c917de251bcb4537c65eed7f65c15c;hp=63ea457f49a18deb3cfb4d034aba9b1a209cfc59;hb=ccc2a54bb3a687478f3fadc0648a603e515e4970;hpb=f25e268ef7519977f6ec162b5c571ee71440e627 diff --git a/mnemon.c b/mnemon.c index 63ea457..db8f62f 100644 --- a/mnemon.c +++ b/mnemon.c @@ -25,6 +25,7 @@ #include #include +#include #include #include #include @@ -48,11 +49,22 @@ typedef struct _bin { item_t **items; } bin_t; +typedef enum { + CATEGORY_ORDER_RANDOM, + CATEGORY_ORDER_SEQUENTIAL +} category_order_t; + typedef struct _category { char *name; int items_size; int num_items; item_t *items; + + /* Support sequential introduction of items from bin 0 */ + category_order_t order; + /* Support categories where responses are timed (0.0 == disable). */ + double time_limit; + int bin_zero_head; } category_t; typedef struct _mnemon { @@ -106,7 +118,21 @@ xstrdup (const char *s) char *ret; ret = strdup (s); - if (s == NULL) { + if (ret == NULL) { + fprintf (stderr, "Error: out of memory\n"); + exit (1); + } + + return ret; +} + +static char * +xstrndup (const char *s, size_t n) +{ + char *ret; + + ret = strndup (s, n); + if (ret == NULL) { fprintf (stderr, "Error: out of memory\n"); exit (1); } @@ -163,6 +189,9 @@ category_init (category_t *category, category->items_size = 0; category->num_items = 0; category->items = NULL; + category->order = CATEGORY_ORDER_RANDOM; + category->time_limit = 0.0; + category->bin_zero_head = 0; } static void @@ -208,6 +237,18 @@ category_add_item (category_t *category, return item; } +static item_t * +category_next_bin_zero_item (category_t *category) +{ + int *i = &category->bin_zero_head; + + for ( ; *i < category->num_items; *i = *i + 1) + if (category->items[*i].score == 0) + return &category->items[*i]; + + return NULL; +} + static void category_print (category_t *category, FILE *file) @@ -215,6 +256,11 @@ category_print (category_t *category, int i; item_t *item; + fprintf (file, "order = %s\n\n", + category->order == CATEGORY_ORDER_RANDOM ? "random" : "sequential"); + fprintf (file, "time = %f\n\n", + category->time_limit); + for (i = 0; i < category->num_items; i++) { item = &category->items[i]; if (i != 0) @@ -279,6 +325,45 @@ bin_remove_item (bin_t *bin, bin->items[item_index] = bin->items[bin->num_items]; } +/* Find the index for an item within a bin. + * + * XXX: This is currently a linear search, so is a potential + * performance problem. + */ +static int +bin_item_index (bin_t *bin, + item_t *item) +{ + int i; + + for (i = 0; i < bin->num_items; i++) + if (bin->items[i] == item) + return i; + + assert (0); +} + +typedef int (item_match_predicate_t) (void *closure, item_t *item); + +/* Return the number of items in the bin from the given category (or + * from all categories if category == NULL) */ +static int +bin_num_items_matching (bin_t *bin, + item_match_predicate_t *predicate, + void *closure) +{ + int i, num_items = 0; + + if (predicate == NULL) + return bin->num_items; + + for (i = 0; i < bin->num_items; i++) + if ((predicate) (closure, bin->items[i])) + num_items++; + + return num_items; +} + static void mnemon_init (mnemon_t *mnemon) { @@ -298,8 +383,8 @@ mnemon_init (mnemon_t *mnemon) mnemon->num_bins = 0; mnemon->bins = NULL; - mnemon->to_introduce = 3; - mnemon->to_master = 0; + mnemon->to_introduce = 10; + mnemon->to_master = 10; mnemon->unlearned = 0; mnemon->mastered = -1; } @@ -332,17 +417,31 @@ mnemon_categories_grow (mnemon_t *mnemon) mnemon->categories_size * sizeof (category_t)); } +/* Get a category by name if it exists */ static category_t * -mnemon_get_category (mnemon_t *mnemon, - const char *name) +mnemon_get_category_if_exists (mnemon_t *mnemon, + const char *name) { int i; - category_t *category; for (i = 0; i < mnemon->num_categories; i++) if (strcmp (mnemon->categories[i].name, name) == 0) return &mnemon->categories[i]; + return NULL; +} + +/* Get a category by name, creating new one if necessary. */ +static category_t * +mnemon_get_category (mnemon_t *mnemon, + const char *name) +{ + category_t *category; + + category = mnemon_get_category_if_exists (mnemon, name); + if (category) + return category; + mnemon_categories_grow (mnemon); category = &mnemon->categories[mnemon->num_categories++]; @@ -414,6 +513,26 @@ chomp (char *s) s[len - 1] = '\0'; } +static char * +trim_space (char *string) +{ + char *s; + + s = string; + while (*s && isspace (*s)) + s++; + + string = s; + + s = string + strlen (string) - 1; + while (s > string && isspace (*s)) { + *s = '\0'; + s--; + } + + return string; +} + static void mnemon_load_category (mnemon_t *mnemon, const char *name) @@ -447,6 +566,65 @@ mnemon_load_category (mnemon_t *mnemon, chomp (line); \ } while (0) + /* Parse options */ + while (1) { + char *name, *equal, *value; + + /* Ignore blank lines */ + READ_LINE; + if (*line == '\0') + continue; + + /* An initial digit means we hit an item. Trigger the + * spaghetti machine. */ + if (*line >= '0' && *line <= '9') + goto PARSE_BIN; + + equal = strchr (line, '='); + if (equal == NULL) { + fprintf (stderr, "Malformed option, (expected name=value): \"%s\" at %s:%d\n", + line, path, line_count); + exit (1); + } + + value = equal + 1; + name = line; + *equal = '\0'; + + name = trim_space (name); + value = trim_space (value); + + if (strcmp (name, "order") == 0) { + if (strcmp (value, "sequential") == 0) { + category->order = CATEGORY_ORDER_SEQUENTIAL; + } else if (strcmp (value, "random") == 0) { + category->order = CATEGORY_ORDER_RANDOM; + } else { + fprintf (stderr, "Unknown value for \"order\" option \"%s\" at %s:%d\n", + value, path, line_count); + exit (1); + } + } else if (strcmp (name, "time") == 0) { + double limit; + char *end; + limit = strtod (value, &end); + while (isspace (*end)) + end++; + if (*end == '\0') { + category->time_limit = limit; + } else { + fprintf (stderr, "Failed to parse time value: %s at %s:%d\n", + value, path, line_count); + exit (1); + } + } else { + fprintf (stderr, "Unknown option %s at %s:%d\n", + name, path, line_count); + exit (1); + } + } + + /* Parse items */ while (1) { int score; char *challenge, *response; @@ -457,6 +635,7 @@ mnemon_load_category (mnemon_t *mnemon, continue; /* Read bin number */ + PARSE_BIN: score = strtol (line, &end, 10); if (*end != '\0') { fprintf (stderr, "Failed to parse bin number from \"%s\" at %s:%d\n", @@ -617,20 +796,92 @@ rand_within_exponential (int num_values) return ones; } +/* Find the category to which an item belongs. */ +static category_t * +mnemon_item_category (mnemon_t *mnemon, + item_t *item) +{ + category_t *category; + int i, item_index; + + for (i = 0; i < mnemon->num_categories; i++) { + category = &mnemon->categories[i]; + item_index = item - category->items; + if (item_index >= 0 && item_index < category->num_items) + return category; + } + + assert (0); +} + +typedef struct _item_in_category_closure +{ + mnemon_t *mnemon; + category_t *category; +} item_in_category_closure_t; + +static int +mnemon_item_in_category (void *closure, item_t *item) +{ + item_in_category_closure_t *iicc = closure; + mnemon_t *mnemon = iicc->mnemon; + category_t *category = iicc->category; + + return (mnemon_item_category (mnemon, item) == category); +} + +typedef struct _item_in_category_of_length_closure +{ + mnemon_t *mnemon; + category_t *category; + int length; +} item_in_category_of_length_closure_t; + +static int +mnemon_item_in_category_of_length (void *closure, item_t *item) +{ + item_in_category_of_length_closure_t *iicolc = closure; + mnemon_t *mnemon = iicolc->mnemon; + category_t *category = iicolc->category; + int length = iicolc->length; + + if (mnemon_item_category (mnemon, item) != category) + return 0; + + return strlen (item->challenge) == length; +} + static void mnemon_select_item (mnemon_t *mnemon, bin_t **bin_ret, - int *item_index_ret) + int *item_index_ret, + category_t **category_ret) { - int bin_index; + int bin_index, item_index; bin_t *bin; + item_t *item; + category_t *category; bin_index = rand_within_exponential (mnemon->num_bins); bin = &mnemon->bins[bin_index]; + item_index = rand_within (bin->num_items); + + item = bin->items[item_index]; + category = mnemon_item_category (mnemon, item); + + if (bin->score == 0) { + if (category->order == CATEGORY_ORDER_SEQUENTIAL) { + item = category_next_bin_zero_item (category); + if (item) + item_index = bin_item_index (bin, item); + } + } + *bin_ret = bin; - *item_index_ret = rand_within (bin->num_items); + *item_index_ret = item_index; + *category_ret = category; } @@ -675,26 +926,56 @@ print_histogram_bar (double size, } static void -mnemon_print_histogram (mnemon_t *mnemon) +mnemon_print_histogram (mnemon_t *mnemon, + const char *category_name, + int length) { int i, last_score, max; + category_t *category = NULL; bin_t *bin; + int num_items; + item_match_predicate_t *predicate = NULL; + void *closure = NULL; + item_in_category_closure_t item_in_category; + item_in_category_of_length_closure_t item_in_category_of_length; if (mnemon->num_bins == 0) return; - max = mnemon->bins[0].num_items; - for (i = 1; i < mnemon->num_bins; i++) - if (mnemon->bins[i].num_items > max) - max = mnemon->bins[i].num_items; + if (category_name) { + category = mnemon_get_category_if_exists (mnemon, category_name); + if (category) { + if (length) { + predicate = mnemon_item_in_category_of_length; + item_in_category_of_length.mnemon = mnemon; + item_in_category_of_length.category = category; + item_in_category_of_length.length = length; + closure = &item_in_category_of_length; + } else { + predicate = mnemon_item_in_category; + item_in_category.mnemon = mnemon; + item_in_category.category = category; + closure = &item_in_category; + } + } + } + + for (i = 0; i < mnemon->num_bins; i++) { + num_items = bin_num_items_matching (&mnemon->bins[i], + predicate, closure); + if (i == 0 || num_items > max) + max = num_items; + } for (i = 0; i < mnemon->num_bins; i++) { bin = &mnemon->bins[i]; if (i != 0) while (bin->score - last_score > 1) printf (HISTOGRAM_ROW_FORMAT "\n", ++last_score, 0); - printf (HISTOGRAM_ROW_FORMAT " ", bin->score, bin->num_items); - print_histogram_bar (bin->num_items, max); + num_items = bin_num_items_matching (bin, + predicate, closure); + printf (HISTOGRAM_ROW_FORMAT " ", bin->score, num_items); + print_histogram_bar (num_items, max); last_score = bin->score; } } @@ -703,10 +984,27 @@ static void mnemon_handle_command (mnemon_t *mnemon, const char *command) { + const char *arg; + int len; switch (command[0]) { case 'h': - mnemon_print_histogram (mnemon); - break; + { + char *category = NULL; + int length = 0; + + arg = command + 1; + arg += strspn (arg, " \t"); + len = strcspn (arg, " \t"); + if (len) { + category = xstrndup (arg, len); + arg += len; + arg += strspn (arg, " \t"); + if (*arg) + length = atoi (arg); + } + mnemon_print_histogram (mnemon, category, length); + } + break; default: printf ("Unknown command: %s\n", command); break; @@ -718,7 +1016,9 @@ mnemon_handle_response (mnemon_t *mnemon, bin_t *bin, int item_index, item_t *item, - const char *response) + const char *response, + double response_time, + double time_limit) { bool_t correct; @@ -735,21 +1035,18 @@ mnemon_handle_response (mnemon_t *mnemon, mnemon_remove_bin (mnemon, bin); } - if (correct) { + if (correct && + (time_limit == 0.0 || response_time < time_limit)) + { item->score++; + mnemon->to_master--; /* We reserve an item score of 0 for an item that has * never been asked. */ if (item->score == 0) { item->score = 1; mnemon->unlearned--; + mnemon->to_master--; printf ("You got it!"); - if (mnemon->to_introduce == 0 && - mnemon->unlearned == 0 && - mnemon->to_master == 0) - { - mnemon->to_master = 10; - mnemon->mastered = 0; - } } else if (item->score < 0) { printf ("Yes---just give me %d more.", - item->score); @@ -757,18 +1054,27 @@ mnemon_handle_response (mnemon_t *mnemon, printf ("On your first try, no less!"); } else { printf ("Masterful (%dx).", item->score); - if (mnemon->to_master) - mnemon->mastered++; } } else { - printf (" %s is the correct answer.", - item->response); + if (! correct) + printf (" %s is the correct answer.", + item->response); + else + printf ("Correct, but not quite quick enough (%0.2f seconds---needed %0.2f seconds)\n", + response_time, time_limit); /* Penalize an incorrect response by forcing the score * negative. */ if (item->score >= 0) { if (item->score > 0) - printf ( " Oops, you knew that, right?\n "); + printf (" Oops, you knew that, right? (%dx)\n ", + item->score); mnemon->unlearned++; + /* We add three here, (rather than just 2 to track the + * change in the item's score below), as an extra + * penalty. If the user is forgetting stuff learned + * previously, then more time should be spent on mastering + * than learning new items. */ + mnemon->to_master += item->score + 3; /* We go to -2 to force a little extra reinforcement * when re-learning an item, (otherwise, it will often * get asked again immediately where it is easy to get @@ -776,6 +1082,7 @@ mnemon_handle_response (mnemon_t *mnemon, item->score = -2; } else { item->score--; + mnemon->to_master++; } } @@ -784,13 +1091,8 @@ mnemon_handle_response (mnemon_t *mnemon, printf ("%d to come. ", mnemon->to_introduce); if (mnemon->unlearned) printf ("%d still unlearned. ", mnemon->unlearned); - if (mnemon->to_master) { - if (mnemon->mastered < mnemon->to_master) - printf ("%d items to master", - mnemon->to_master - mnemon->mastered); - else - printf ("Great job!"); - } + if (mnemon->to_introduce == 0 && mnemon->to_master > 0) + printf ("%d items to master", mnemon->to_master); printf ("\n\n"); bin = mnemon_get_bin (mnemon, item->score); @@ -804,6 +1106,7 @@ mnemon_do_challenges (mnemon_t *mnemon) bin_t *bin; int item_index; item_t *item; + category_t *category; char *response; int i; @@ -838,37 +1141,56 @@ mnemon_do_challenges (mnemon_t *mnemon) printf ("\n"); do { - mnemon_select_item (mnemon, &bin, &item_index); + struct timeval start, end; + + mnemon_select_item (mnemon, &bin, &item_index, &category); item = bin->items[item_index]; if (bin->score == 0) mnemon->to_introduce--; while (1) { + if (category->time_limit > 0.0) { + response = readline ("The next one is timed. Press enter when ready:"); + free (response); + } + printf ("%s\n", item->challenge); + gettimeofday (&start, NULL); response = readline ("> "); + gettimeofday (&end, NULL); + /* Terminate on EOF */ if (response == NULL) { printf ("\n"); return; } - if (response[0] == '/') + if (response[0] == '/') { mnemon_handle_command (mnemon, response + 1); - else + free (response); + } else { break; + } } mnemon_handle_response (mnemon, bin, item_index, - item, response); - } while (mnemon->mastered < mnemon->to_master); + item, response, + (end.tv_sec + end.tv_usec / 1e6) - + (start.tv_sec + start.tv_usec / 1e6), + category->time_limit); + free (response); + } while (mnemon->to_introduce || + mnemon->unlearned || + mnemon->to_master > 0); } int main (int argc, char *argv[]) { mnemon_t mnemon; + char *response; srand (time (NULL)); @@ -882,5 +1204,15 @@ main (int argc, char *argv[]) mnemon_fini (&mnemon); + mnemon_init (&mnemon); + mnemon_load (&mnemon); + + printf ("Great job.\nHere are your current results:\n"); + mnemon_print_histogram (&mnemon, NULL, 0); + response = readline ("Press enter to quit.\n"); + free (response); + + mnemon_fini (&mnemon); + return 0; }