File: List.h

package info (click to toggle)
torch 2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 5,488 kB
  • ctags: 3,217
  • sloc: cpp: 14,272; makefile: 201
file content (89 lines) | stat: -rw-r--r-- 2,574 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
// Copyright (C) 2002 Ronan Collobert (collober@iro.umontreal.ca)
//                
//
// This file is part of Torch. Release II.
// [The Ultimate Machine Learning Library]
//
// Torch is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Torch is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Torch; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef LIST_INC
#define LIST_INC

#include "general.h"

namespace Torch {

/** List structure used in all the library.
   @author Ronan Collobert (collober@iro.umontreal.ca)
 */
struct List
{
    /** Integer, which is not always used.
        Usually, if #ptr# is a table, it contains
        the number of elements in this table
    */
    int n;

    /// Pointer which can be used as you want
    void *ptr;

    /// Next node, NULL if nothing.
    List *next;
};

/// List functions
//@{

/** Add  #y# to at the end of #*x#.
    Note: if #*x# is empty, #*x# \emph{must} be NULL.
    @author Ronan Collobert (collober@iro.umontreal.ca)
*/
void addToList(List **x, List *y);

/** Add the node {#n#, #ptr#} at the end of #*x#.
    Note: if #*x# is empty, #*x# \emph{must} be NULL.
    @author Ronan Collobert (collober@iro.umontreal.ca)
*/
void addToList(List **x, int n, void *ptr);

/** Copy the content of list #from# into the list #to#.
    This supposes that each list contains a vector of real
    in each node. The number of real which will be copied
    is given by #to#.
    @author Ronan Collobert (collober@iro.umontreal.ca)
*/
void copyList(List* to, List* from);

/** Copy the content of list #from# into the vector #to#.
    This supposes the list contains a vector of real
    in each node. The number of real which will be copied
    is given by #from#.
    @author Ronan Collobert (collober@iro.umontreal.ca)
*/
void copyList(real* to, List* from);

/** Destroy the list #*x#.
    It can free the memory inside each node (in #ptr#)
    if #free_ptrs# == #true#.
    @author Ronan Collobert (collober@iro.umontreal.ca)
*/
void freeList(List **x, bool free_ptrs=false);

//@}


}

#endif