upgrading.texi 3.14 KB
Newer Older
Nicolas Burrus's avatar
Nicolas Burrus committed
1
2
3
4
5
6
@documentencoding ISO-8859-1

@node Upgrading from older versions
@chapter Upgrading from older versions

@menu
David Lesage's avatar
David Lesage committed
7
* Upgrading from 0.8 to 0.9::
Nicolas Burrus's avatar
Nicolas Burrus committed
8
9
10
* Upgrading from 0.7 to 0.8::
@end menu

David Lesage's avatar
David Lesage committed
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
@node Upgrading from 0.8 to 0.9
@section Upgrading from 0.8 to 0.9

Abstract interfaces are available and dispatch the methods to their
implementations. Thus, it is not necessary to downcast abstract-typed
variables through ``Exact_ref'', ``Exact_cref'', ``Exact_ptr'' or
``Exact_cptr'' macros anymore.

Abstract classes have moved from ``oln'' to ``oln::abstract''
namespace.
 
@itemize @minus
@item oln::image => oln::abstract::image
@item oln::iter => oln::abstract::iter
@item oln::neighborhood => oln::abstract::neighborhood
@item oln::point => oln::abstract::point
@item oln::struct_elt => oln::abstract::struct_elt
@item oln::w_window => oln::abstract::w_window
@item oln::window => oln::abstract::window
@end itemize

The ``data'' concept changed into the ``implementation''
one. The ``implementation'' can be simple data storage, but
it will also provide special proxies and function-generated
images. The access to this ``implementation'' has changed from
``data()'' to ``impl()'' member function.

Functions modifying borders were made image member functions. 

@itemize @minus
@item border::set_width()  => abstract::image::border_set_width()
@item border::adapt_width()  => abstract::image::border_adapt_width()
@item border::adapt_copy()  => abstract::image::border_adapt_copy()
@item border::adapt_mirror()  => abstract::image::border_adapt_mirror()
@item border::adapt_assign()  => abstract::image::border_adapt_assign()
@end itemize

Olena now has its own coding style
(http://www.lrde.epita.fr/cgi-bin/twiki/view/Projects/OlenaCodingStyle).

In particular, macros have been renamed:

@itemize @minus
@item Exact(I) => mlc_exact_type(I)
@item Point(I) => oln_point_type(I)
@item Iter(I) => oln_iter_type(I)
@end itemize

Typedefs have been renamed too:

@itemize @minus
@item image2d<bin>::iter => image2d<bin>::iter_type
@item image2d<bin>::point => image2d<bin>::point_type
@end itemize

More details can be found in the coding style web page.

Nicolas Burrus's avatar
Nicolas Burrus committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@node Upgrading from 0.7 to 0.8
@section Upgrading from 0.7 to 0.8

Olena has been massively reorganized between versions 0.7 and 0.8. The
idea was to split the library into three distinct components:

@itemize @minus
@item Image processing
@item Basic data types
@item Meta programming tools
@end itemize

Thus, two additional directories and namespaces have been created:

@itemize @minus
@item @file{mlc/} directory and @code{mlc} namespace for 
      meta-programming tools
@item @file{ntg/} directory and @code{ntg} namespace for data types
@end itemize

Here is the list of general renaming rules for header files: 

@itemize @minus
@item @file{<oln/types/*.hh>} => @file{<ntg/*.hh>}
@item @file{<oln/meta/*.hh>} => @file{<mlc/*.hh>}
@item @file{<oln/core/type.hh>} => @file{<mlc/type.hh>}
@item @file{<oln/core/contract.hh>} => @file{<mlc/contract.hh>}
@end itemize

Namespaces changes can be deduced from files renaming. Indeed, each
file moved into @file{mlc/} has seen its member moved into the
@code{mlc} namespace. The same rule stands for @code{ntg}.