Birthday Money.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:05.780008Z",
     "iopub.status.busy": "2022-12-31T21:13:05.780008Z",
     "iopub.status.idle": "2022-12-31T21:13:05.902759Z",
     "shell.execute_reply": "2022-12-31T21:13:05.902759Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.558731900Z",
     "start_time": "2023-09-10T10:45:14.511088300Z"
    }
   },
   "outputs": [],
   "source": [
    "%reload_ext jetisu.query_idr_magic"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "# Birthday Money\n",
    "\n",
    "## Source\n",
    "\n",
    "| Key               | Value                                                                                                   |\n",
    "|-------------------|---------------------------------------------------------------------------------------------------------|\n",
    "| Author            | Ram Parameswaran                                                                                        |\n",
    "| Link              | [![Birthday Monday](https://img.youtube.com/vi/qnn8p8xaP1U/0.jpg)](https://youtu.be/qnn8p8xaP1U?t=3999) |\n",
    "| Original Language | OpenFisca                                                                                               |\n",
    "| Retrieved         | 2022-Nov-27                                                                                             |\n",
    "\n",
    "_Lets revisit the example above using sigma complete relations (IDRs)..._\n",
    "\n",
    "## Initially a flat rate that applies to all children\n",
    "\n",
    "Initially the policy for birthday money was calculated as $10.00 per year. Here is a sigma complete relation:\n",
    "```standard_birthday_money``` that captures this."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:05.907776Z",
     "iopub.status.busy": "2022-12-31T21:13:05.902759Z",
     "iopub.status.idle": "2022-12-31T21:13:05.917655Z",
     "shell.execute_reply": "2022-12-31T21:13:05.917099Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.564259400Z",
     "start_time": "2023-09-10T10:45:14.560728700Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": "<IPython.core.display.Markdown object>",
      "text/markdown": "```\n\npredicate standard_birthday_money(\n        var int: age,\n        var float: birthday_money) =\nlet {\n    constraint birthday_money = age*10.00; % constraints express a relationship\n} in true;\n```"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "%%jetisu_show\n",
    "standard_birthday_money"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "The language used to define sigma complete relations is not so important, the crucial aspect is that the reader, and the computing system, understand the predicate.  The\n",
    "definition above happens to have been written in [MiniZinc](https://www.minizinc.org/).\n",
    "\n",
    "Sigma complete relations can be queried as if they are an ordinary database table that contains _all_ the answers. With this table defined, the\n",
    "following query gives the expected answer:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:05.964904Z",
     "iopub.status.busy": "2022-12-31T21:13:05.964904Z",
     "iopub.status.idle": "2022-12-31T21:13:06.180047Z",
     "shell.execute_reply": "2022-12-31T21:13:06.178036Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.634818100Z",
     "start_time": "2023-09-10T10:45:14.565258500Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": "<IPython.core.display.Markdown object>",
      "text/markdown": "|age|birthday_money|\n|----|----|\n|10.0|100.0|"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "%%jetisu_query\n",
    "select * from standard_birthday_money where age = 10;"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "And Query 2 also gives the same answer!"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:06.185751Z",
     "iopub.status.busy": "2022-12-31T21:13:06.184749Z",
     "iopub.status.idle": "2022-12-31T21:13:06.409012Z",
     "shell.execute_reply": "2022-12-31T21:13:06.408005Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.735018800Z",
     "start_time": "2023-09-10T10:45:14.631819100Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": "<IPython.core.display.Markdown object>",
      "text/markdown": "|age|birthday_money|\n|----|----|\n|10|100.0|"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "%%jetisu_query\n",
    "select * from standard_birthday_money where birthday_money=100;"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "Notice that the relationship can be queried from multiple directions.\n",
    "## Made conditional on behaviour\n",
    "\n",
    "At some point of time, the amount of birthday money was made contingent on the child's behaviour. Here is the second version.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:06.413025Z",
     "iopub.status.busy": "2022-12-31T21:13:06.412018Z",
     "iopub.status.idle": "2022-12-31T21:13:06.419969Z",
     "shell.execute_reply": "2022-12-31T21:13:06.418964Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.736022900Z",
     "start_time": "2023-09-10T10:45:14.731760900Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": "<IPython.core.display.Markdown object>",
      "text/markdown": "```\n\npredicate new_birthday_money(\n    var int: age,\n    var bool: good_behaviour,\n    var float: birthday_money) =\nlet {\n    constraint birthday_money = if good_behaviour then age*20.00 else 0.00 endif\n} in true;\n```"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "%%jetisu_show\n",
    "new_birthday_money"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "If we now repeat ```Query 1``` we get a different output."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:06.422969Z",
     "iopub.status.busy": "2022-12-31T21:13:06.422969Z",
     "iopub.status.idle": "2022-12-31T21:13:06.605963Z",
     "shell.execute_reply": "2022-12-31T21:13:06.605963Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.824151200Z",
     "start_time": "2023-09-10T10:45:14.737023Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": "<IPython.core.display.Markdown object>",
      "text/markdown": "|age|good_behaviour|birthday_money|\n|----|----|----|\n|10.0|False|0|"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "%%jetisu_query\n",
    "select * from new_birthday_money where age = 10 ;"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "This may be read as \"a child turning ten will receive either nothing, or two hundred dollars birthday money\"\n",
    "\n",
    "As soon as we know the behaviour of the person, we can find the actual birthday money with the following query:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:06.610986Z",
     "iopub.status.busy": "2022-12-31T21:13:06.610986Z",
     "iopub.status.idle": "2022-12-31T21:13:06.844966Z",
     "shell.execute_reply": "2022-12-31T21:13:06.844966Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.902218900Z",
     "start_time": "2023-09-10T10:45:14.821116500Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": "<IPython.core.display.Markdown object>",
      "text/markdown": "|age|good_behaviour|birthday_money|\n|----|----|----|\n|10.0|True|200.0|"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "%%jetisu_query\n",
    "select * from new_birthday_money where age = 10 and good_behaviour;"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "And again to show that the direction of querying is flexible:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:06.850476Z",
     "iopub.status.busy": "2022-12-31T21:13:06.849479Z",
     "iopub.status.idle": "2022-12-31T21:13:07.045315Z",
     "shell.execute_reply": "2022-12-31T21:13:07.045315Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:14.978241Z",
     "start_time": "2023-09-10T10:45:14.899221600Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": "<IPython.core.display.Markdown object>",
      "text/markdown": "|good_behaviour|\n|----|\n|True|"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "%%jetisu_query\n",
    "select good_behaviour from new_birthday_money\n",
    "    where age = 10\n",
    "        and birthday_money = 200;"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "# Test Data\n",
    "The sigma complete relation lends itself to automated generation of test cases.  Here is an example of a test case that can be validated then copied and used with [pytest](https://docs.pytest.org/). The name of the function is generated by hashing the input query."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {
    "collapsed": false,
    "execution": {
     "iopub.execute_input": "2022-12-31T21:13:07.048324Z",
     "iopub.status.busy": "2022-12-31T21:13:07.048324Z",
     "iopub.status.idle": "2022-12-31T21:13:07.195718Z",
     "shell.execute_reply": "2022-12-31T21:13:07.195718Z"
    },
    "ExecuteTime": {
     "end_time": "2023-09-10T10:45:15.046526400Z",
     "start_time": "2023-09-10T10:45:14.976260300Z"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "def test_idr_4cbd6b19e0():\n",
      "    res = idr_query(\"\"\"select good_behaviour from new_birthday_money\n",
      "    where age = 10\n",
      "        and birthday_money = 200;\n",
      "\"\"\", 'data')\n",
      "    assert idr_test_res_sort(res) == idr_test_res_sort((('good_behaviour',), [(True,)]))\n"
     ]
    }
   ],
   "source": [
    "%%jetisu_testcase\n",
    "select good_behaviour from new_birthday_money\n",
    "    where age = 10\n",
    "        and birthday_money = 200;"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "## Next step\n",
    "You can edit and re-run this example workbook by following the instructions here:\n",
    "[How to run the example notebooks](https://github.com/DavidPratten/jetisu/blob/main/docs/run_notebooks.md)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.1"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}