{
 "cells": [
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#  Save and load data in polymake\n",
    "\n",
    "In polymake there are different ways to save and load data depending on the type and the format of the data. We distinguish between polymake objects (Polytope, Matroid,...), complex data types (Set, Matrix, Array<Vector<Rational> >,...), and data from files in arbitrary formats.\n",
    "\n",
    "## Handling polymake objects\n",
    "\n",
    "Let us take this nice example object:\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "$p = cube(3);"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To store polymake objects use the command\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "save($p,\"myPolyObject.poly\");"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "polymake objects that are stored in polymake's own XML file format can be loaded via\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "$p=load(\"myPolyObject.poly\");"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If you did not start `polymake` in the directory containing your object, it is necessary to add the relative path, e.g.\n",
    "    $p=load(\"MyFolder/myPolyObject.poly\");\n",
    "\n",
    "**Note:** If you load a polymake object and compute new properties, these properties will automatically be added to the original XML-file at the end of the session. You can suppress this with the command \n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "$p->dont_save;"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "called prior to leaving the session (but after the last compuation with $p).\n",
    "\n",
    "## Handling complex data types\n",
    "\n",
    "It is also possible to store complex data structures in XML format via `save_data`, e.g.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "$s=new Set<Int>(1,2,3,4);\n",
    "save_data($s,\"mySet.poly\");"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To load such files just type\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "$s=load_data(\"mySet.poly\");"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "## Handling arbitrary files\n",
    "\n",
    "Of course, it is also possible to load data from files in other formats. For this purpose use the standard Perl functions for reading and writing. Here is an example:\n",
    "\n",
    " Assume you want to load some points stored in the file points.txt which looks like this:\n",
    "    1 0 0 0\n",
    "    1 1 0 0\n",
    "    1 0 1 0\n",
    "    1 1 1 0\n",
    "    1 0 0 1\n",
    "    1 1 0 1\n",
    "    1 0 1 1\n",
    "    1 1 1 1\n",
    "For the sake of the example, let's create this file:\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "open(my $f, '> points.txt'); print $f \"1 0 0 0\\n1 1 0 0\\n1 0 1 0\\n1 1 1 0\\n1 0 0 1\\n1 1 0 1\\n1 0 1 1\\n1 1 1 1\\n\"; close $f;"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To read this file try the following:\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "open(INPUT, \"< points.txt\");\n",
    "while(<INPUT>){\n",
    "  print $_;\n",
    "}\n",
    "close(INPUT);"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "<INPUT> is a perl input iterator reading the file line by line.  Variable `$_` refers to the current line within this loop; it has a plain string value.\n",
    "\n",
    " A reasonable task could be to store the points from the file as a matrix.  This can be done immediately, because the matrix constructor called with a list of values interprets each value as a matrix line:\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "open(INPUT, \"< points.txt\");\n",
    "$matrix=new Matrix<Rational>(<INPUT>);\n",
    "close(INPUT);"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "\n",
    "\n"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "polymake",
   "language": "polymake",
   "name": "polymake"
  },
  "language_info": {
   "codemirror_mode": "perl",
   "file_extension": ".pm",
   "mimetype": "text/x-polymake",
   "name": "polymake"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}